[texdoc-commits] [SCM] texdoc updated: r28 - trunk
takuto at gnu.org.ua
takuto at gnu.org.ua
Tue Nov 21 05:34:16 CET 2017
Author: takuto
Date: 2017-11-21 06:34:15 +0200 (Tue, 21 Nov 2017)
New Revision: 28
Modified:
trunk/TODO.md
trunk/texdoc.cnf
Log:
update TODO.md and texdoc.cnf
Modified: trunk/TODO.md
===================================================================
--- trunk/TODO.md 2017-11-20 06:50:01 UTC (rev 27)
+++ trunk/TODO.md 2017-11-21 04:34:15 UTC (rev 28)
@@ -1,7 +1,11 @@
-# For the next release (version 3.0)
+# TODO list for texdoc
-## Fuzzy search
+This file public domain.
+## For the next release (version 3.0)
+
+### Fuzzy search
+
Texdoc will run fuzzy search when texdoc can't find any document with
traditional searching method. The basic concept of the fuzzy search
implementation is already written:
@@ -14,7 +18,7 @@
fuzzy_search = true | false | interact
```
-## New option parser
+### New option parser
We would like to follow POSIX demands as much as possible.
@@ -22,16 +26,16 @@
Texdoc will provide better error messages as well.
-## Documentation update
+### Documentation update
Write explanations for new features and make the information (e.g. current
maintainers) up-to-date.
-# Future works
+## Future works
-## Documents not included in TeX Live
+### Documents not included in TeX Live
-### Method 1
+#### Method 1
A variety of alias to specify absolute path. Allow to write `texdoc.cnf`
something like:
@@ -40,13 +44,13 @@
alias* foo = /path/to/your/foobar.pdf
```
-### Method 2
+#### Method 2
Make it possible to specify particular directory (e.g. `~/texdoc`) and search
the documents in the directory with ordinal way.
([Frank's suggestion](https://github.com/latex3/latex3/issues/384#issuecomment-344206155))
-## Scoring overhaul
+### Scoring overhaul
Good package (either from the tlpdb or directory name) should be much more
important for scoring. E.g.
@@ -68,14 +72,14 @@
See aliases marked `XXX` in `texdoc.cnf`.
-## Using tlpdb
+### Using tlpdb
There are some ideas to make this better:
* Using `texlive/tlpdb.tlu` for tlpdb reading
* Make the parsing faster so that the no cache file is needed
-## Misc
+### Misc
* Wirte many test scripts (for internal functions as well)
* Make the list of good and/or bad comments from the catalogue configurable?
@@ -85,7 +89,7 @@
* cf. Some people want to search document by macro name
* Try to guess which `*.tex` files are examples and allow them?
-## Notes by former maintainer (mpg)
+### Notes by former maintainer (mpg)
```
New options
Modified: trunk/texdoc.cnf
===================================================================
--- trunk/texdoc.cnf 2017-11-20 06:50:01 UTC (rev 27)
+++ trunk/texdoc.cnf 2017-11-21 04:34:15 UTC (rev 28)
@@ -20,6 +20,7 @@
#
# For more details, see the texdoc manual (try `texdoc texdoc').
+
# General settings
# ================
@@ -87,6 +88,7 @@
# Known suffixes for documentation
suffix_list = doc, -doc, _doc, .doc, /doc, manual, /manual, -manual, userguide, /user_guide, -guide, -user, -man, notes, -info, ref
+
# Score adjustments
# =================
@@ -124,16 +126,16 @@
adjscore /tex-virtual-academy-pl/ = -50
# test and example files are not likely the best documentation
-adjscore example = -3
-adjscore examples = -3
-adjscore sample = -3
-adjscore samples = -3
-adjscore test = -3
-adjscore tests = -3
-adjscore /demo/ = -3
-adjscore /demos/ = -3
-adjscore /figures/ = -3
-adjscore /images/ = -3
+adjscore example = -3
+adjscore examples = -3
+adjscore sample = -3
+adjscore samples = -3
+adjscore test = -3
+adjscore tests = -3
+adjscore /demo/ = -3
+adjscore /demos/ = -3
+adjscore /figures/ = -3
+adjscore /images/ = -3
# readme's usually get a negative score because they have a bad extension,
# but they're still slightly better than other results with negative scores
@@ -161,7 +163,8 @@
adjscore(latex) ocr-latex = -10
adjscore(latex) tufte-latex = -10
# file names
-
+adjscore(latex) Content_LaTeX_Package_Demo = -10
+adjscore(latex) example_latex = -10
adjscore(latex) test_latex = -10
# beamer
@@ -171,10 +174,10 @@
adjscore(beamer) presentations = -10
# misc
-adjscore(context) circuitikz = -10
-adjscore(context) /gnuplot/ = -3
+adjscore(context) circuitikz = -10
+adjscore(context) /gnuplot/ = -3
adjscore(context) context.man1 = +2
-adjscore(symbols) /staves/ = -5
+adjscore(symbols) /staves/ = -5
# catalogue info missing in the tlcontrib version of the package :-(
adjscore(pgf) pgfmanual.pdf = +5
@@ -182,6 +185,7 @@
# context version is found first
adjscore(fixme) /third/ = -6
+
# Aliases
# =======
@@ -194,8 +198,8 @@
## Essential documentation
-alias live = texlive-en
-alias texlive = texlive-en
+alias live = texlive-en
+alias texlive = texlive-en
alias tex-live = texlive-en
## various stuff
@@ -365,42 +369,42 @@
alias l3luatex = interface3
# misc
-alias autofe = ucs
-alias afoot = arabtex-doc
-alias arabicfont = bezos
-alias bibtex = btxdoc
-alias changes = changes.english.pdf
-alias(5) cmsuper = cm-super/FAQ
-alias cm-super = cm-super/README
-alias cmsuper = cm-super/README
-alias cyrillic = cyrillic/00readme.txt
-alias elsarticle = elsdoc
-alias(0.1) fontinst = fontinstallationguide
-alias hyperref = hyperref/manual.pdf
-alias hyperref-dev = hyperref.pdf
-alias iso = isoman
-alias lettrine = lettrine # to hide context/third/lettrine-doc.pdf
-alias nonfloat-de = nonfloat
-alias nonfloat = nonfloat-en
-alias xstring-fr = xstring_doc_fr
-alias arabic = arabi/user_guide
-alias 3parttable = threeparttable
-alias croatian = babel
-alias mls = montex
-alias vrbexin = verbasef
-alias dtk = dtk/doc/beispiel.pdf
-alias musixtex = musixdoc
-alias mychemistry = mychemistry_en
-alias mychemistry-de = mychemistry_de
-alias cjk = CJK.txt # FIXME: should be case insensitive
-alias ieee = IEEEtran_HOWTO
-alias layouts = layman
-alias plnfss = plnfss.txt # XXX
-alias teubner = teubner-doc
-alias xypic = xyguide
+alias autofe = ucs
+alias afoot = arabtex-doc
+alias arabicfont = bezos
+alias bibtex = btxdoc
+alias changes = changes.english.pdf
+alias(5) cmsuper = cm-super/FAQ
+alias cm-super = cm-super/README
+alias cmsuper = cm-super/README
+alias cyrillic = cyrillic/00readme.txt
+alias elsarticle = elsdoc
+alias(0.1) fontinst = fontinstallationguide
+alias hyperref = hyperref/manual.pdf
+alias hyperref-dev = hyperref.pdf
+alias iso = isoman
+alias lettrine = lettrine # to hide context/third/lettrine-doc.pdf
+alias nonfloat-de = nonfloat
+alias nonfloat = nonfloat-en
+alias xstring-fr = xstring_doc_fr
+alias arabic = arabi/user_guide
+alias 3parttable = threeparttable
+alias croatian = babel
+alias mls = montex
+alias vrbexin = verbasef
+alias dtk = dtk/doc/beispiel.pdf
+alias musixtex = musixdoc
+alias mychemistry = mychemistry_en
+alias mychemistry-de = mychemistry_de
+alias cjk = CJK.txt # FIXME: should be case insensitive
+alias ieee = IEEEtran_HOWTO
+alias layouts = layman
+alias plnfss = plnfss.txt # XXX
+alias teubner = teubner-doc
+alias xypic = xyguide
alias kvoptions-patch = kvoptions # XXX?
-alias cweb = cwebman # XXX: is in 'cweb' dir, should win
-alias einfuehrung = einfuehrung/README # tl should get "readme" tag
+alias cweb = cwebman # XXX: is in 'cweb' dir, should win
+alias einfuehrung = einfuehrung/README # tl should get "readme" tag
## a few easy patterns
@@ -476,6 +480,7 @@
alias(4.1) topcapt = topcapt.sty
alias(4.1) vrbexin = vrbexin.sty
+
# Final hack
#
# The next line has no effect when this file is installed as the last
More information about the texdoc-commits
mailing list