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

Contents of /trunk/TODO.md

Parent Directory Parent Directory | Revision Log Revision Log


Revision 28 - (show annotations)
Tue Nov 21 04:34:15 2017 UTC (3 years, 10 months ago) by takuto
File size: 5429 byte(s)
update TODO.md and texdoc.cnf
1 # TODO list for texdoc
2
3 This file public domain.
4
5 ## For the next release (version 3.0)
6
7 ### Fuzzy search
8
9 Texdoc will run fuzzy search when texdoc can't find any document with
10 traditional searching method. The basic concept of the fuzzy search
11 implementation is already written:
12
13 * <https://gist.github.com/wtsnjp/2b193a5b8096126050055f12ea90ee43>
14
15 Maybe we will provide a new config file option like:
16
17 ```
18 fuzzy_search = true | false | interact
19 ```
20
21 ### New option parser
22
23 We would like to follow POSIX demands as much as possible.
24
25 * cf. <http://lua-users.org/wiki/AlternativeGetOpt>
26
27 Texdoc will provide better error messages as well.
28
29 ### Documentation update
30
31 Write explanations for new features and make the information (e.g. current
32 maintainers) up-to-date.
33
34 ## Future works
35
36 ### Documents not included in TeX Live
37
38 #### Method 1
39
40 A variety of alias to specify absolute path. Allow to write `texdoc.cnf`
41 something like:
42
43 ```
44 alias* foo = /path/to/your/foobar.pdf
45 ```
46
47 #### Method 2
48
49 Make it possible to specify particular directory (e.g. `~/texdoc`) and search
50 the documents in the directory with ordinal way.
51 ([Frank's suggestion](https://github.com/latex3/latex3/issues/384#issuecomment-344206155))
52
53 ### Scoring overhaul
54
55 Good package (either from the tlpdb or directory name) should be much more
56 important for scoring. E.g.
57
58 * With `texdoc article`
59 * `spie/article.pdf` should never get such a high score
60 * With `texdoc todo`
61 * `todo/todo-spl.pdf` should win over `todonotes/todonotes.pdf`
62 * With `texdoc ean`
63 * `ean/Readme` should win over `barcodes/eandoc` (probably)
64 * With `texdoc bxtexlogo`
65 * `bxtexlogo-sample.pdf` is not necessary to be the best
66 * but also it should not be judged as "bad" (get score <0)
67
68 Files found using the tlpdb only should be scored heuristically as if
69 `<pkgname>` were asked for. Make sure heuristic scoring returns a higher score
70 for names actually containing the string. (Check the result with `psnfss2e`
71 aliases.)
72
73 See aliases marked `XXX` in `texdoc.cnf`.
74
75 ### Using tlpdb
76
77 There are some ideas to make this better:
78
79 * Using `texlive/tlpdb.tlu` for tlpdb reading
80 * Make the parsing faster so that the no cache file is needed
81
82 ### Misc
83
84 * Wirte many test scripts (for internal functions as well)
85 * Make the list of good and/or bad comments from the catalogue configurable?
86 * Currently, "readme" is only hard-coded as "bad"
87 * e.g. "package documentation" might get a bonus
88 * Provide interfaces for Plug-ins?
89 * cf. Some people want to search document by macro name
90 * Try to guess which `*.tex` files are examples and allow them?
91
92 ### Notes by former maintainer (mpg)
93
94 ```
95 New options
96 -----------
97
98 --html-lists options: output the lists as html (à la mthelp)
99
100 --index-by-topic: build on the fly a local version of the catalogue's
101 bytopic.html page (see also --apropos)
102
103
104 Not sure about that
105 -------------------
106
107 Information from the tlpdb isn't always as up-to-date as the catalogue, in case
108 the catalogue has been fixed for a package that wasn't update. Should I generate
109 Data.meta.lua directly from a fresh catalogue version?
110 For now, just force update of the packages in TL when I notice.
111
112 Try guessin lang from file name when there is no info in the catalogue?
113
114 What to do with tools/coverage? May want to discuss this with Phlipp S.
115
116 tlpdb cache should check if ext_list has changed, in theory.
117 Is it worth it in practice? I'll do it if someone complains...
118
119 BUG: finds non-existing files in tl2010 (probably from another tlpdb?)
120 ex: texdoc luasseq on my machine while tl10 is active
121 Ok, got it: tlpdb cache is not invalidated when switching to an older
122 tlpdb files from the same release. I wonder if it's worth fixing.
123
124 Caching: now used only for tlpdb. Is it worth using it for ls-R files?
125 Configuration files?
126
127 Add support for shell-style globs (standard regex is probably too hard)
128 Well, would anyone really use it? (would be for patterns in texdoc.cnf, not
129 for texdoc arguments)
130
131 Use the 2-links trick from kpse when exploring trees? Check how it works on
132 windows.
133
134
135 Using the catalogue
136 -------------------
137
138 Obsolescence information could be useful (Phil's suggestion), but may be hard to
139 obtain (not in the tlpdb)... Well, if it's in the catalogue, I can ship a
140 Data.obsolete.lua file with the information...
141
142 Do something with the description from the catalogue?
143
144 Help maintainers standardise comments in order to allow for more accurate
145 scoring/classification?
146
147 --apropos using Jim's keywords and categorization, see Karl's mail:
148 http://tug.org/pipermail/texdoc/2010q3/000213.html
149
150
151 Auto-generation of doc files ???
152 --------------------------------
153
154 To allow installing TL without the doc trees (cuts off the size by 2).
155 Suggested by Will.
156
157
158 Port on MikTeX ???
159 ------------------
160
161 Lots of TeX-live specific stuff (implicitly) embedded in various places...
162
163 Add a function in texlua's kpse library returning all files for which a certain
164 Lua function (given as argument) returns true. Use only it.
165
166 What to do with all the functions using tlpdb? Is it possible to use an
167 equivalent on MikTeX?
168
169 Adapt to the different tree layout in MikTeX (TEXMFHOME etc don't exist).
170
171 How to detect the distro? What to do with aliases?
172
173
174 Notes and references
175 --------------------
176
177 Texdoc GUI project going on since early May 2010, see messages from Enrico
178 Gregorio in my (mpg) inbox.
179
180 Used by vim script #2945 (AutomaticTexPlugin) as F1 and :TexDoc.
181
182 ```

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