summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/nicetext/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/nicetext/README')
-rw-r--r--Master/texmf-dist/doc/latex/nicetext/README73
1 files changed, 52 insertions, 21 deletions
diff --git a/Master/texmf-dist/doc/latex/nicetext/README b/Master/texmf-dist/doc/latex/nicetext/README
index 171fd1d339f..b2b7811b975 100644
--- a/Master/texmf-dist/doc/latex/nicetext/README
+++ b/Master/texmf-dist/doc/latex/nicetext/README
@@ -2,14 +2,22 @@
(c) 2009 Uwe Lueck http://contact-ednotes.sty.de.vu
+
== General Idea ==
-The NICETEXT bundle offers ``minimal'' markup syntax for rather
+The NICETEXT bundle supports ``minimal'' markup syntax for rather
simple kinds of text. The code you type should show little more
characters than are printed, though you get LaTeX quality. We try
to do away with backslashes, technical terms, and curly braces
(which also are so clumsy to type on PC keyboards).
+Main focus is easy documentation of LaTeX packages. Preprocessing
+by Perl or so is replaced by TeX macros (reviving/generalizing the
+'docstrip' idea), including expandable, safe, correct string
+substitution and typographical enhancements of plain text for
+LaTeX input.
+
+
== Packages ==
'wiki.sty' addresses general kinds of texts. 'niceverb.sty' is
@@ -23,37 +31,60 @@ you just type
\foo[<opt-arg>]{<mand-arg>}
!-)
- == Comparison ==
+'fifinddo.sty' provides basic setup for text filtering, especially
+string substitution. 'makedoc.sty' extends it to provide a simple
+script language for transforming plain text package files into LaTeX
+input files [manual!?]. One LaTeX run can perform preprocessing and
+typesetting.
+
+
+ == Comparisons ==
-One source of inspiration is the markup syntax that is used in
-editing Wikipedia pages. The package 'wiki.sty' of the bundle
-offers a very similar syntax as a LaTeX front-end. It suffices for
-italics, boldface, sectioning, and certain list-like environments.
-This is also similar to 'easylatex',
+One source of inspiration is the markup syntax of editing Wikipedia
+pages. 'wiki.sty' of the bundle offers something similar as a LaTeX
+front-end for italics, boldface, sectioning, and certain list-like
+environments. This is also similar to 'easylatex',
http.//www.ctan.org/pkg/easylatex
-which is more powerful and uses Perl. 'wiki.sty', by contrast, is
-just a LaTeX package, working on any TeX installation.
+which is more powerful and uses Perl. NICETEXT, by contrast, consists
+just of LaTeX packages, working on any TeX installation [!? note
+restrictions in 'fifinddo.pdf']. Cf. also preprocessor packages
+'txt2tex' and 'txt2latex'.
+
+Concerning ``self-documentation,'' there is a difference to current
+`\DocInput', similar ideas are in 'gmdoc' and 'lineno.sty',
+see 'niceverb.pdf' and 'makedoc.pdf'. Standard 'doc.sty' and
+'contrib' extensions of it are rather avoided.
+
+There are several *LaTeX macro* packages for processing text or
+databases or for editing TeX's input stream while typesetting
+-- see 'fifinddo.pdf'. What seems to be new here is
+*expandable string substitution* and safe, correct detection of
+substrings -- discussed in 'fifinddo.pdf'.
+
== Documentation ==
+'fifinddo.pdf' describes 'fifinddo.sty', typeset from 'fifinddo.tex'.
+'makedoc.pdf' describes 'makedoc.sty', typeset from 'makedoc.tex'.
+'niceverb.pdf' describes 'niceverb.sty', typeset from 'niceverb.tex'.
+
+Typesetting them anew (for customizing printout) requires
+'makedoc.cfg', 'mdcorr.cfg', 'mkfddoc.tex' and the *.sty files
+in the working directory (no special guarantee that your hacks will
+work!) Cf. provided *.log files for what was input for *.pdf.
+
'wikicheat.pdf' is a one-page manual of 'wiki.sty'. The file
-'wiki.sty' contains additional documentation as ASCII text.
-'niceverb.pdf' describes 'niceverb.sty'. Note that certain
-features must be activated by commands in the document environment.
+'wiki.sty' contains additional documentation as plain text.
+Note that certain features must be activated by commands in the
+document environment.
+
== What is missing ==
-1. 'niceverb' should extend 'wiki', yet their font switchings are
-incompatible at present. 2. 'niceverb' should typeset the ASCII
-documentation of 'wiki.sty' ... This upload is for reference and
-for proving that I am not just dreaming. I think repairing needs
-only few hours, yet I must do something different right now. See
-more on what's missing in 'niceverb.pdf'.
+A lot, see niceverb.pdf and fifinddo.pdf.
-3. I have a package 'nicedots' for controlling horizontal spacing
-with ellipses which may go here.
________________________________
- [This file 2009/02/23 Uwe Lueck]
+ [This file 2009/04/15 Uwe Lueck]