/ [texdoc] / trunk / TODO
To checkout: svn checkout http://svn.gnu.org.ua/sources/texdoc/trunk/TODO
Puszcza

Contents of /trunk/TODO

Parent Directory Parent Directory | Revision Log Revision Log


Revision 9 - (show annotations)
Thu May 11 17:42:06 2017 UTC (4 years, 6 months ago) by karl
File size: 4352 byte(s)
capitalize conventional filenames
1 For next release
2 ================
3
4 alias fixme = latex/fixme/fixme doesn't work (see Dan's report 2011-10-08)
5
6 aliases for *cite.sty? see cite/README
7
8 fix FIXME in texdoc.cnf (alias cjk.txt not working, maybe a case issue)
9
10 Scoring overhaul
11 ----------------
12
13 Good package (either from the tlpdb or directory name) should be much more
14 important for scoring. Eg, spie/article.pdf should never get such a high score
15 for article.
16
17 With "texdoc todo",
18 todo/todo-spl.pdf
19 should win over
20 todonotes/todonotes.pdf Package documentation
21
22 With "texdoc ean"
23 ean/Readme
24 should win over
25 barcodes/eandoc = Package doc
26 (probably)
27
28 Files found using the tlpdb only should be scored heuristicly as if <pkgname>
29 were asked for. (Make sure heurisitc scoring returns a higher score for
30 names actually containing the string. Check the result with psnfss2e aliases.)
31
32 see aliases marked XXX in texdoc.cnf
33
34 For later
35 =========
36
37 Internal
38 --------
39
40 Use texlive/tlpdb.tlu for tlpdb reading.
41
42 Get ready for Lua 5.2?
43
44 Misc
45 ----
46
47 Use alt-getopt for options parsing (needs to be patched for error handling and
48 optional arguments: write my own gnu_getopt_long?) (Reinhard working on
49 something, too.)
50
51 Make the list of bad comments from the catalogue configurable? (Currently,
52 readme hardcoded.)
53
54 --html-lists options: output the lists as html (à la mthelp)
55
56 --index-by-topic: build on the fly a local version of the catalogue's
57 bytopic.html page (see also --apropos)
58
59 Searching by macro name???
60 - http://tug.org/pipermail/tex-live/2010-May/025832.html
61 - other ideas?
62
63 Make list of "better" comments from the catalogue, for example
64 "documentation" might get a bonus.
65
66 Try to guess which .tex files are examples and allow them?
67
68
69 Not sure about that
70 -------------------
71
72 Information from the tlpdb isn't always as up-to-date as the catalogue, in case
73 the catalogue has been fixed for a package that wasn't update. Should I generate
74 Data.meta.lua directly from a fresh catalogue version?
75 For now, just force update of the packages in TL when I notice.
76
77 Try guessin lang from file name when there is no info in the catalogue?
78
79 What to do with tools/coverage? May want to discuss this with Phlipp S.
80
81 tlpdb cache should check if ext_list has changed, in theory.
82 Is it worth it in practice? I'll do it if someone complains...
83
84 BUG: finds non-existing files in tl2010 (probably from another tlpdb?)
85 ex: texdoc luasseq on my machine while tl10 is active
86 Ok, got it: tlpdb cache is not invalidated when switching to an older
87 tlpdb files from the same release. I wonder if it's worth fixing.
88
89 Caching: now used only for tlpdb. Is it worth using it for ls-R files?
90 Configuration files?
91
92 Add support for shell-style globs (standard regex is probably too hard)
93 Well, would anyone really use it? (would be for patterns in texdoc.cnf, not
94 for texdoc arguments)
95
96 Use the 2-links trick from kpse when exploring trees? Check how it works on
97 windows.
98
99
100 Using the catalogue
101 -------------------
102
103 Obsolescence information could be useful (Phil's suggestion), but may be hard to
104 obtain (not in the tlpdb)... Well, if it's in the catalogue, I can ship a
105 Data.obsolete.lua file with the information...
106
107 Do something with the description from the catalogue?
108
109 Help maintainers standardise comments in order to allow for more accurate
110 scoring/classification?
111
112 --apropos using Jim's keywords and categorization, see Karl's mail:
113 http://tug.org/pipermail/texdoc/2010q3/000213.html
114
115
116 Auto-generation of doc files ???
117 --------------------------------
118
119 To allow installing TL without the doc trees (cuts off the size by 2).
120 Suggested by Will.
121
122
123 Port on MikTeX ???
124 ------------------
125
126 Lots of TeX-live specific stuff (implicitly) embedded in various places...
127
128 Add a function in texlua's kpse library returning all files for which a certain
129 Lua function (given as argument) returns true. Use only it.
130
131 What to do with all the functions using tlpdb? Is it possible to use an
132 equivalent on MikTeX?
133
134 Adapt to the different tree layout in MikTeX (TEXMFHOME etc don't exist).
135
136 How to detect the distro? What to do with aliases?
137
138
139 Notes and references
140 --------------------
141
142 Texdoc GUI project going on since early May 2010, see messages from Enrico
143 Gregorio in my (mpg) inbox.
144
145 Used by vim script #2945 (AutomaticTexPlugin) as F1 and :TexDoc.

Send suggestions and bug reports to Sergey Poznyakoff
ViewVC Help
Powered by ViewVC 1.1.20