tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated outdated README

Browse Source
This commit is contained in:
Jean-Francois Dockes 2019-11-29 09:58:45 +01:00
parent ead58a2265
commit 357a76221c
1 changed files with 4 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/doc/user/00README.txt
View File

@ -8,23 +8,8 @@ two problems:
- Dependancy on the FreeBSD platform.
- No support for UTF-8 (last I looked), only latin1.
The manual is now compatible with XML. There is a small script that
converts the SGML (but XML-compatible) manual into XML (changes the header,
mostly). The SGML version is still the primary one.
The manual has been converted to docbook XML a long time ago.
Beyond fixing a few missing closing tags, the main change that had to be
made was to make the anchors explicitly upper-case because the SGML
toolchain converts them to upper-case and the XML one does not, so the only
way to have compatibility is to make them upper-case in the first place.
We initially had a problem for producing the PDF manual, which motivated
keeping the SGML version for producing the PDF with the FreeBSD SGML
toolchain. This problem is now solved with dblatex, so that the SGML
version now has little reason to persist and it will go away at some point
in the future.
Asciidoc would also be a candidate as the source format, because it can
easily produce docbook, so the future will probably be:
asciidoc->docbook-xml-> html
-> pdf
It uses xsltproc and the docbook style sheets to produce the single-page
HTML version, dblatex for the PDF version, and webhelp for the multi-page
HTML version.