A quest for the Holy Grail of technical documentation
Chris Karakas
www.karakas—online.de
| Revision History |
| Revision 1.4 |
20.09.2007 |
Revised by: CK |
| Added sections on start and end files, HTML headers and footers. Changed chapters resp. sections: Shortcomings and bugs, Main part, LaTeX
errors. New files: example.start, example.end, part1, part2, part3, keycombos, keycombos2, acronyms, acronyms2, productnames, productnames2, applications, applications2. Changed files: lyxtox. |
| Revision 1.3 |
12.03.2006 |
Revised by: CK |
Files changed: sedscr, lyxtox, lyxtox-print-pdf.dsl, lyxtox-print.dsl, awkscr_insert_index_items, ck-style.css, jadetex.cfg, addd. New sed scripts, sedscr_apa and
sedscr_ima, take care of alt and title attributes in the HTML format, so that the resulting files remain W3C compliant. Previous versions might not be, because a phrase element inside a textobject
was not used for the alt attribute, due probably to a bug in the DSSSL stylesheets. sgmltools is not needed anymore. Corrected a bug in awkscr_insert_index_items that would break index entry
insertion after the first entry. Added code in sedscr that will take care of keycombos, acronyms, productnames and index entries of key combinations. Use of a new script, coolthumbs, for the creation
of antialiased thumbnails in PDF. Further changes in: The final step, Unprintable characters, SP_ENCODING in "Set environment vars", Using Type 1 fonts, Choosing the right font encoding, Using True
Type fonts, Optimal PDF—Figures, Acrobat
Reader 5 does not display thumbnails. Added a whole chapter on Localization (work
in progress). Simplified addd script. Generated new Index (almost 2000 entries!). |
| Revision 1.2 |
25.06.2004 |
Revised by: CK |
| The tidy scripts have been deactivated in lyxtox. They mess up other areas like callouts or displayed code — but they are still in the package. Corrections to
sedscr and awkscr_math scripts to handle inequalities correctly: now writing a < b > c in Math Mode will not result in an Openjade parser error about an "undefined element b". The jadetex.cfg
file now contains examples of how to get customized headers and footers in PDF through the fancyhdr package (works only partly — ideas welcome) and also an example of using the underscore
package to get underscores correctly in links — but this messes up the smiley names which also contain underscores. |
| Revision 1.1 |
13.06.2004 |
Revised by: CK |
| Discussion of newer LyX versions (newer than 1.2.0), as well as new errors and warnings. Inclusion of sedscr_tidy and sedscr_tidy2 sed scripts that tidy up the SGML code.
The lyxtox script contains calls to those two scripts, otherwise no changes have been made to the scripts. |
| Revision 1.0 |
19.02.2004 |
Revised by: CK |
| Initial public release. |
A method for single-source publishing using LyX and SGML is presented: LyX is used as a comfortable graphical SGML editor. Once the document is exported to SGML from LyX, it undergoes a series of
transformations through sed and awk scripts that correct and enhance the SGML markup, compute the Index, insert the Bibliography and the Appendix and take care of the correct invocation of openjade,
pdftex, pdfjadetex and all the other necessary programs for the generation of HTML (chunked or not), PDF (with images, bookmarks, thumbnails and hyperlinks), PS, RTF and TXT versions. All aspects of
document processing are handled, including automatic Index generation, display of Mathematics in TeX quality both online and in print formats, as well as the use of
bibliographic databases with RefDB. Special care is taken so that the document processing is as transparent to the user as possible - the aim being that the user writes in LyX, then presses a button,
and the lyxtox script does the rest.
