Menu
CTAN
Comprehensive TeX Archive Network
Cover Upload Browse

Direc­tory tex-archive/macros/latex/contrib/nicetext

               README for the NICETEXT bundle

      Minimal Markup for Documenting, Text Filtering, ...

   (c) 2009-2012 Uwe Lueck http://contact-ednotes.sty.de.vu


                     == General Idea ==

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 (clumsy to type ... - "syntactic sugar"). 

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 
made for documenting LaTeX packages. `niceverb.sty' especially 
offers [almost-]WYSIWIG for meta-variables (macro arguments) 
and for referring to commands (and their syntax) in footnotes, 
section titles etc. E.g., to get the syntax description

                 \foo[<opt-arg>]{<mand-arg>}
you just type 
                 \foo[<opt-arg>]{<mand-arg>}
!-)

`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 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. 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'. 

Regarding "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'. `mdoccheat.pdf' is a list of script 
commands, typeset from `mdocchea.tex'. `niceverb.pdf' describes 
`niceverb.sty', typeset from `niceverb.tex'. Typesetting them 
anew (for customizing printout) requires `makedoc.cfg', 
`mdoccorr.cfg', and the *.sty files.

`wikicheat.pdf' is a one-page manual of `wiki.sty'. The file 
`wiki.sty' contains additional documentation as plain text. 
Note that certain features must be activated by commands in the 
document environment.


                   == Templates/Dialogue ==

txt to TeX functionality through \MakeDocCorrectHook can be 
tried and applied with templates `fdtxttex.tpl' and 
`makedoc.tpl' and in a dialogue started by running 
`fdtxttex.tex'. Running `copyfile.tex', you get a dialogue 
for "compressing" blank lines or text encoding conversion.

`substr.tex' should typeset the version of Harald Harders' 
`substr.sty' next at your TeX installation. `arseneau.tex' 
should typeset documentation of a few packages by Donald 
Arseneau. MY results are `substr.pdf' and `arseneau.pdf'.


                        == License ==

Copying, distributing, modifying, using the files of the 
`nicetext' bundle are allowed under the terms of the 
LaTeX Project Public License, either version 1.3a or any later 
version, the latest version is at 

    http://www.latex-project.org/lppl.txt

There is NO WARRANTY, and you must CARE indeed with `fifinddo' 
and `makedoc', they will OVERWRITE existing files without 
warning (because their main purpose is updating). 

The bundle is AUTHOR-MAINTAINED in the sense of the LPPL.

Copyright (C) 2009-2012 Uwe Lueck, 

    http://www.contact-ednotes.sty.de.vu 

Please report bugs, problems, and suggestions via the previous 
web form. 


                  == Installing/Required ==

`makedoc.sty' requires the `moreverb' package from 

    CTAN:/macros/latex/contrib/moreverb

You find the latest public version of the NICETEXT bundle at

    http://mirror.ctan.org/macros/latex/contrib/nicetext/

A TDS version `nictext.tds.zip' is available at

    http://mirror.ctan.org/install/macros/latex/contrib/


               ________________________________
               [This file 2012/11/27 Uwe Lueck]

Direc­to­ries

Name Notes
demo
doc
docsrc
run
use

Files

Name Size Date Notes
ANNOUNCE.txt 585 2012-11-27 11:11
FILEs.txt 2770 2012-11-27 10:21
README 5023 2012-11-27 06:09
README.pdf 20059 2012-11-27 06:09
SrcFILEs.txt 1939 2012-11-30 03:36

Down­load the con­tents of this pack­age in one zip archive (2.6M).

nice­text – Min­i­mal markup for sim­ple text (Wikipedia style) and doc­u­men­ta­tion

The bun­dle of­fers “min­i­mal” markup syn­tax for var­i­ous sim­ple kinds of text. The user will typ­i­cally in­volve lit­tle more than is printed, and will still get LaTeX qual­ity.

The bun­dle pro­vides four pack­ages:

  • wiki ad­dresses gen­eral texts, marked up in the sim­ple style used on Wikipedia;
  • nice­verb is yet an­other means of doc­u­ment­ing LaTeX pack­ages: it of­fers syn­tax-aware type­set­ting of meta-vari­ables (macro ar­gu­ments) and for re­fer­ring to com­mands (and their syn­tax) in foot­notes, sec­tion ti­tles etc.;
  • fifinddo aims to parse plain text or (La)TeX files us­ing TeX, and to write the re­sults to an ex­ter­nal file; the pack­age is used by an­other mem­ber of the bun­dle:
  • make­doc, which pro­vides the means to pro­duce type­set doc­u­men­ta­tion di­rect from pack­age files.

Pack­age De­tailsnice­text
Ver­sion0.65
Li­censeThe LaTeX Project Public Li­cense
Copy­right2009, 2010 Uwe Lück
Main­tainerUwe Lück
TDS archivenicetext.tds.zip
Con­tained inTeXlive as nice­text
MikTeX as nice­text
Topics al­ter­na­tive markup scheme
See also makedtx
doc
txt2latex
easyLaTeX
gmdoc
Guest Book Sitemap Contact