diff options
author | Karl Berry <karl@freefriends.org> | 2009-02-26 00:51:49 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2009-02-26 00:51:49 +0000 |
commit | b3fd7332ea18e6172db25318716832397b625ddd (patch) | |
tree | 27ded3c17ec00519723a3a8b29e84680e60bedd4 /Master/texmf-dist/doc/latex/nicetext | |
parent | 951ab8ce2fe8420509db19af0937bdddb314b1de (diff) |
new latex package nicetext (24feb09)
git-svn-id: svn://tug.org/texlive/trunk@12236 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/nicetext')
-rw-r--r-- | Master/texmf-dist/doc/latex/nicetext/README | 59 | ||||
l--------- | Master/texmf-dist/doc/latex/nicetext/README.txt | 1 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/nicetext/docsrc/WIKICHEA.TEX | 148 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/nicetext/docsrc/makedoc.tex | 82 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/nicetext/docsrc/niceverb.tex | 261 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/nicetext/niceverb.pdf | bin | 0 -> 138688 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/nicetext/wikicheat.pdf | bin | 0 -> 78545 bytes |
7 files changed, 551 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/nicetext/README b/Master/texmf-dist/doc/latex/nicetext/README new file mode 100644 index 00000000000..171fd1d339f --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/README @@ -0,0 +1,59 @@ + The NICETEXT bundle + + (c) 2009 Uwe Lueck http://contact-ednotes.sty.de.vu + + == General Idea == + +The NICETEXT bundle offers ``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). + + == 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>} +!-) + + == Comparison == + +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', + + 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. + + == Documentation == + +'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. + + == 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'. + +3. I have a package 'nicedots' for controlling horizontal spacing +with ellipses which may go here. + + ________________________________ + [This file 2009/02/23 Uwe Lueck] diff --git a/Master/texmf-dist/doc/latex/nicetext/README.txt b/Master/texmf-dist/doc/latex/nicetext/README.txt new file mode 120000 index 00000000000..100b93820ad --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/README.txt @@ -0,0 +1 @@ +README
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/nicetext/docsrc/WIKICHEA.TEX b/Master/texmf-dist/doc/latex/nicetext/docsrc/WIKICHEA.TEX new file mode 100644 index 00000000000..e56bff99120 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/docsrc/WIKICHEA.TEX @@ -0,0 +1,148 @@ +\ProvidesFile{wikicheat}[2008/07/10 Cheatsheet for wiki.sty] +% \def\title{Cheatsheet for the \textsf{wiki} Package} +\def\title{\textbf{Cheatsheet} for the \textbf{\textsf{wiki}} Package} +\def\author{Uwe L\"uck} +\documentclass[12pt,a4paper]{article} +\nofiles +\pagestyle{empty} +\makeatletter +\@ifundefined{UndeclareTextCommand}{}{\usepackage{upquote}} %% 2008/07/02 +\makeatother +\usepackage{wiki} +% \let\WE\relax \let\WF\relax \let\WH\relax +\let\WE\wikiEnvironments +\let\WF\wikiFonts +\let\WH\wikiHeadings +\def\SP#1{\multicolumn{3}{\VR c\VR}{% +% \parbox{11cm}{% + \parbox{13cm}{% + \footnotesize\it\sloppy\SU#1\SD}}} +\def\SL{/\hskip.16667em} +% \setbox0\hbox{(}\showthe\ht0\showthe\dp0 %% height = 3x depth +\def\SU{\rule{0pt}{.99em}}%%%{1.1em}} +\def\HSU{\rule{0pt}{.75em}} +\def\SD{\rule[-.33em]{0pt}{0pt}}%%%45em]{0pt}{0pt}} +% \def\CS#1{{\tt\textbackslash #1}} %% 2008/07/02 +{\makeatletter \gdef\CS#1{{\tt\@backslashchar#1}}} +\let\VR| \catcode`\|\active \def|{\verb|} +\begin{document} +% \maketitle + +\enlargethispage{3\normalbaselineskip} +\vspace*{-\topmargin} %% !? +\vspace*{-\headheight}\vspace*{-\headsep}\vspace*{-\topsep}\vspace*{-\partopsep} +\begin{center} +\large \title\\[.4ex] \normalsize +Some \LaTeX-Markup through some Wiki-Markup\\[.8ex] + \author, \today +% \end{center} + +\vspace{\topsep} +\vspace*{\partopsep} +% \vspace{1.5ex} +% \vspace{1ex} +% \hrule +% \vspace{1ex} + +% \begin{center} +\leavevmode\kern-1em +\begin{tabular}{\VR l\VR l\VR l\VR} +\hline\hline +\SU\SD\bf Code for \textsf{wiki.sty}&\bf What you get& \bf like \LaTeX-code\\ +\hline\hline +|''italic''|&\WF ''italic''&|\textit{italic}|\SU\\ +|'''bold'''|&\WF '''bold'''&|\textbf{bold}|%%%\\ +\SD\\ +% |'''''bf+it'''''|&\WF '''''bf+it''''' +% &|\textbf{\textit{bf+it}}|\SD\\ +% |'''''B+I'''''|&\WF '''''B+I''''' &|\textbf{\textit{B+I}}|\SD\\ +\hline +\SP{``Italic'' and ``bold'' may be combined, nested, overlap. +% Automatic italic correction cannot be suppressed by \CS{nocorr}. +% Implementation uses \LaTeX\ internals; no groups are formed. +Quotation marks +% (even German) +usually are not +affected.---Turn +% {\tt '\string{\string}''} may help with +% apostrophes.---Turn +font feature on/off by \CS{wikiFonts}\SL\CS{nowikiFonts}; disable feature +entirely by package option {\tt noFonts}.}\\ +\hline\hline +|== Level 1 ==|&\Large\bf\HSU 1\quad Level 1&|\section{Level 1}|\SU\\ +|=== Level 2 ===|&\large\bf 1.1\quad Level 2&|\subsection{Level 2}|\SU\\ +|==== Level 3 ====|&\bf 1.1.1\quad Level 3&|\subsubsection{Level 3}|\\ +|===== Level 4 =====|&\bf Level 4 &|\paragraph{Level 4}|\SD\\ +|====== Level 5 ======|&\bf Level 5 &|\subparagraph{Level 5}|\SD\\ +\hline +\SP{Turn heading feature on/off by \CS{wikiHeadings}\SL\CS{nowikiHeadings}; +disable feature entirely by package option {\tt noHeadings}.}\\ +\hline\hline +&&|\begin{itemize}|\SU\\ +|* One|&\textbullet\hspace\labelsep One &|\item One|\\[2\parsep] +|* Two|&\textbullet\hspace\labelsep Two &|\item Two|\\ +&&|\end{itemize}|\SD\\ +\hline +&&|\begin{enumerate}|\SU\\ +|# One|&1.\hspace\labelsep One &|\item One|\\[2\parsep] +|# Two|&2.\hspace\labelsep Two &|\item Two|\\ +&&|\end{enumerate}|\SD\\ +\hline +&&|\begin{description}|\SU\\ +|;[club] explain|&\textbf{club}\hspace\labelsep explain + &|\item[club] explain|\\[2\parsep] +|;[widow] explain|&\textbf{widow}\hspace\labelsep explain + &|\item[widow] explain|\\ +&&|\end{description}|\SD\\ +\hline + & &|She wrote:|\SU\\ +|She wrote:|&\smash{\raisebox{\topsep}{She wrote:}}&|\begin{quote}|\\ +|:Indeed| &\hspace\leftmargini Indeed&|Indeed|\\ + & &|\end{quote}|\SD\\ +\hline + & &|Type|\SU\\ +|Type| &\smash{\raisebox{\topsep}{Type}}&|\begin{verbatim}|\\ +| \typeout{OK!}| &|\typeout{OK!}|&|\typeout{OK!}|\\ + & &|\end{verbatim}|\SD\\ +\hline +\SP{A \CS{begin} is executed when {\tt*} etc.\ is first character of a +code line; an indent starts {\tt verbatim}. +\CS{end} is executed at code line without indent and not beginning with +{\tt*} etc.---Turn this feature on by \CS{wikiEnvironments}; turn off by +\CS{nowikiEnvironments}, e.g., to get around incompatibilities +(lists feature is most dangerous). +Disable feature entirely by package option {\tt noEnvironments}. +Package option {\tt noVerbatim} instead may usually suffice, +if you don't want to have any {\tt verbatim}.}\\ +\hline +\end{tabular} +\kern-1em +\end{center} + +% \section{Test}\subsection{Sub-Test}\subsubsection{Subsub-Test} +% \paragraph{Para}\subparagraph{Sub-Para} + +\footnotesize +% \vspace{2ex} +\sloppy +\noindent \WE\WF %%% '''Please note:''' +''Note:'' +% * +Explicit '''turning on''' by %%% one of +% \[|\wikiEnvironments|,\quad |\wikiFonts|,\quad |\wikiHeadings|\] +|\wikiEnvironments| %%% , |\wikiFonts|, |\wikiHeadings|, +etc.\ +% or by |\wikimarkup| (which executes the former three) is ''required''; +is '''required'''; +e.g., after %%% |\maketitle| and +|\tableofcontents|. +|\wikimarkup| '''activates ''all''''' the features. +% * +|\nowikimarkup| %%% executes all of +% \[|\nowikiEnvironments|,\quad |\nowikiFonts|,\quad |\nowikiHeadings|.\] +% |\nowikiEnvironments|, |\nowikiFonts|, |\nowikiHeadings|. +% Use them to get around incompatible code. +'''''dis''ables all''' of them, e.g., to get around incompatibilities. + +\end{document} + diff --git a/Master/texmf-dist/doc/latex/nicetext/docsrc/makedoc.tex b/Master/texmf-dist/doc/latex/nicetext/docsrc/makedoc.tex new file mode 100644 index 00000000000..65beb83f9f1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/docsrc/makedoc.tex @@ -0,0 +1,82 @@ +\ProvidesPackage{makedoc.tex}[2009/02/21 (UL)] +%% make packagecode environments and remove percents starting lines + +\makeatletter \catcode`\_=11 + +\openin\@inputcheck=niceverb.sty %% JUST HERE +\newwrite\result_file + \immediate\openout \result_file=niceverb.doc %% JUST HERE + +\newif\if_package_code_ \_package_code_false +% \newif\if_empty_code_lines_ \_empty_code_lines_false + %% <- FAILED SO FAR +% \let\maybe_result_empty_line\empty +% \def\result_empty_line{^^J} + +\def\write_result{\immediate\write\result_file} + +\def\process_file{% + %% This macro here to avoid category changes + %% affecting the present code + \begingroup + \let\do\@makeother \dospecials + %% from docstrip.tex: + \@makeother\^^A\@makeother\^^K\endlinechar\m@ne + %% <- cf. TeXbook "extended keyboards" up-/downarrow + %% -> "math specials", cf. "space specials" + \@makeother\^^I% ASCII horizontal tab -- guessed!? ^^L!? +% \tracingmacros=1 + \loop \ifeof\@inputcheck \else + \read\@inputcheck to \InputLine + \expandafter \process_line \InputLine ======&%% primitive version + \repeat + \endgroup} + +\def\process_line#1===#2===#3&{%% may be preferable to wiki.sty + \ifx$#2$% + \ifx$#1$% +% \show\InputLine + \if_package_code_ +% \if_empty_code_lines_ +% \write_result{}\_empty_code_lines_false +% \fi + \else + \write_result{}% +% \let\maybe_result_empty_line\result_empty_line + \fi + \else +% \show\InputLine + \if_package_code_ +% \_empty_code_lines_true + \else + \write_result{\string\begin{packagecode}}% + \_package_code_true + \fi + \write_result{#1}% +% \write_result{\maybe_result_empty_line #1}% +% \let\maybe_result_empty_line\empty + \fi + \else + \write_result{% + \string\end{packagecode}^^J^^J% + \string\subsection{\ignorespaces#2\unskip}^^J}% + \_package_code_false +% \_empty_code_lines_false + \fi} + +\process_file + +\write_result{\string\end{packagecode}} +\closein\@inputcheck \immediate\closeout\result_file + +\endinput + +\stop + %% TODO or \ThankYou; which NICEVERB.TEX may redefine into \endinput + %% or \ThankYou issues \endinput if jobname ... + %% the whole file may be enclosed in \begingroup ... \endgroup + %% ... this is a "driver file"!? + +TODO make own listing environment like this -- own linewise processing, + without verbatim.sty + diff --git a/Master/texmf-dist/doc/latex/nicetext/docsrc/niceverb.tex b/Master/texmf-dist/doc/latex/nicetext/docsrc/niceverb.tex new file mode 100644 index 00000000000..be4c19e3e43 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/docsrc/niceverb.tex @@ -0,0 +1,261 @@ +\ProvidesFile{niceverb.tex}[2009/02/23 documenting niceverb.sty] +\title{\textsf{niceverb.sty}\\---\\Minimizing + Markup\\for Documenting \LaTeX\ packages\thanks{This + manual describes package version + version 0.1 as of February 23, 2009%%%\fileversion\ as of \filedate\ + .}}%%%of the package.}} +\author{Uwe L\"uck\\{\tt http://contact-ednotes.sty.de.vu}} +\input{makedoc} +\documentclass[12pt,a4paper]{article} +\usepackage{niceverb} +\usepackage{moreverb} +% \usepackage{verbatim} +\newenvironment{packagecode} + {\PackageCode} + {\endPackageCode} + \gdef\PackageCode{\listing[5]{1}} + \gdef\endPackageCode{% + \endlisting + \global\let\PackageCode\listingcont + \global\let\endPackageCode\endlistingcont} +\begin{document} +\maketitle + +\tableofcontents + +\section{Presenting 'niceverb'} +\subsection{Purpose} +% \begin{abstract}\noindent +% The 'nicetext' bundle provides ``minimal'' markup +The 'niceverb' package provides ``minimal'' markup for documenting \LaTeX\ +packages, reducing the number of keystrokes/visible characters needed +% .\,.\,. %%% ... %% TODO nicedots +(kind of poor man's WYSIWYG).\footnote{``What you see is what you +get.'' Novices are always warned that WYSIWYG is essentially +impossible with \LaTeX.} +% One feature---\verb'&\foo'%%% badly self-documenting, `&' fails +It conveniently handles command names in arguments of macros +such as &\footnote or even of sectioning commands. +% (`.aux'/`.toc' entries). +% +% This is done by making some characters active. +% 'niceverb.sty' thus resembles 'wiki.sty'; both are siblings. +% \end{abstract} +Commands for typesetting a package's code are inserted +automatically (just using \TeX). %%%\footnote{Stephan I. B\"ottcher used +%%%'AWK' instead to typeset the documentation of his 'lineno.sty'.} +As opposed to tools that are rather common on UNIX/Linux, this +operation should work at any \TeX\ installation, irrespective of +platform. + +The package may at least be useful while working at a very new package +and may suffice with small, simple packages. After having edited your +package's code (typically in a `.sty' file), you just ``{`latex'}'' the +manual file (maybe some `.tex' file) and get instantly the corresponding +refreshed documentation. + +'niceverb' may also help to generate without much effort documentations +of nowadays commonly expected typographical quality for packages that +so far only had ASCII documentations. + +\subsection{Acknowledgement/Basic Ideas} +Three ideas of Stephan I. B\"ottcher's in documenting his 'lineno.sty' +inspired the present work: +\begin{enumerate} +\item +The markup and its definitions are short and simple, +markup commands are placed at the right ``margin'' +of the ASCII file, +so you hardly see them in reading the source file, +you rather just read the text that will be printed. +\item +An 'AWK' script removes the `%'s starting \emph{documentation} lines +and inserts the commands for typesetting the package's \emph{code} +(you don't see them in the source). +\item +An active character (\lq`|'\rq) issues a `\string' \emph{and} switches +to typewriter typeface for typesetting a command verbatim---so this +works without changing category codes (which is the usual idea of +typesetting code), therefore it works even in macro arguments. +\end{enumerate} + +\subsection{The Commands and Features of 'niceverb'} + +Single quotes \verb|`|, \verb|'|, ``less than'' \verb|<| (accompanied +with \verb|>|), the hash mark \verb|#|, ampersand \verb|&|, and in an +extended ``auto mode'' even backslash \verb|\| become &\active +characters with ``special effects.'' + +The package mainly aims at typesetting commands and descriptions of their +syntax \emph{if the latter is ``standard \LaTeX-like''}, +using ``meta-variables.'' A string to be +typeset ``verbatim'' thus is assumed to start with a single command like +&\foo, maybe followed by stars (\lq`*'\rq) and pairs of +square brackets (`['.\,.\,.`]') or +curly braces (\verb'{'.\,.\,.\verb'}'), +where those pairs contain strings indicating the typical +kinds of contents for the respective arguments of that command. +A typical example is this: +$$&\foo*[<opt-arg>]{<mand-arg>}$$ +This was achieved by typing \verb'&\foo*[<opt-arg>]{<mand-arg>}'. +In ``auto mode'' of the package, even typing +$$\verb|\foo*[<opt-arg>]{<mand-arg>}|$$ + %% angle brackets feature to be suppressed here! +would have sufficed---WYSIWYG! (I call such mixtures of +\emph{verbatim} and ``meta-variables'' \textit{\lq meta-code\rq}.) + +Now for the details: +\begin{description} + +\item[``Meta-variables:''] {\sloppy The package supports the ``angle +brackets'' style of ``meta-variables'' (as with <meta-variable>). +You just type \lq\verb'<foo>'\rq\ to get \lq<foo>\rq.\par} + +This works due to a sloppy variant &\SimpleVerb of &\verb +which doesn't care about possible ligatures and definitions of active +characters. Instead, it assumes that the ``verbatim'' font doesn't +contain ligatures anyway. \lq\verb'\verb|<foo>|'\rq, by contrast, just +yields \lq\verb'<foo>'\rq. + +Almost the same feature is offered by 'ltxguide.cls' which formats the +basic guides from the \LaTeX\ Project Team. The present feature, +however, also works in plain text outside verbatim mode. +% On the other hand: without << feature + +\item[Single quotes (left/right) for ``short verb:''] +{\sloppy The package ``assumes'' that \emph{quoting} refers to +\emph{code}, therefore \lq\verb|`foo'|\rq\ is typeset as +\lq`foo'\rq. This somewhat resembles the &\MakeShortVerb feature of +'doc.sty'.\par} + +It will typically fail when you try to typeset commands (and their +syntax) in \emph{macro arguments}---e.g., +$$\verb|\footnote{`\bar' is a celebrated fake example!}|$$ +will try to \emph{execute} &\bar instead of typesetting it, giving +an ``undefined'' error so. +\verb|\verb| fails in the same situation, for the same reason. +\lq\verb|&|\rq\ (&\footnote{&&&\bar<remaining>}) or +``auto mode'' (see below) may then work better. + +Double quotes and apostrophes should still work the usual way; +otherwise you could control the parsing mechanisms using curly braces +(outside and inside don't interact). +To get usual single quotes, you can use their standard substitutes +`\lq' and `\rq'. +You can ``abuse'' this ``single quotes'' feature just to get typewriter +typeface.\footnote{In macro arguments this requires that the right +single quote &' is &\active.} +For difficult cases, you can still use the standard `\verb' +command from \LaTeX. + +\item[Single right quotes for &\textsf:] +{\sloppy Package names are (by some unwritten convention!?) +typeset with `\textsf'; +it was natural to use a remaining case of using single quotes +for replacing &\textsf{<text>} by \SimpleVerb|'<text>'|.\footnote{% +Font switching by sequences of single quotes is a feature of the +syntax for editing Wikipedia pages and of 'wiki.sty'.}\par} +%% TODO fails in parentheses due to preserving apostrophes + +This idea of switching fonts continues font switching of 'wiki.sty' +which uses the syntax for editing Wikipedia pages. + +\item[Ampersand \lq&&\rq\ typesets command syntax even in arguments:] +\hfil e.g., type \lq\verb|&\foo{<arg>}|\rq\ to get +\lq`\foo{<arg>}'\rq. This may be even more convenient for typing than +the single quotes method, although looking somewhat strange. +However, `&' may terminate \textit{verbatim} unexpectedly, being +designed for displaying ``\LaTeX-like command syntax'' in the first +instance.\footnote{Moreover, && currently has a limited 'xspace' +functionality only.}\footnote{You can even use && for referring to +active characters like && in footnotes etc.!} + +\begin{sloppypar} +This choice of `&' rests on the assumption that there won't be many +tables in the documenation. You can restore the usual meaning of `&' +by \verb|\MakeAlign\&| and turn the present special meaning on again by +$$\verb|\MakeActiveLet\&\CmdSyntaxVerb|.$$ +You could also +redefine (&\renewcommand) &\descriptionlabel using `\CmdSyntaxVerb' +(the ``normal command'' equivalent to `&') so \verb|\item[\foo]| works +as wanted. +\end{sloppypar} + +\item[``Auto mode'' typesets commands verbatim unless .\,.\,.] +{\sloppy +\hfil In~``auto mode'', the backslash \lq`\'\rq\ is an active character that +builds a command name from the ensuing letters and typesets the +command (and its syntax, allowing meta-variables) verbatim. +However, there are some exceptions, which are collected in a macro +&\niceverbNoVerbList. &\begin, &\end, and &\item belong to this list, +you can redefine (`\renewcommand') it. +There is also a command &\NormalCommand{<letters>} \emph{issuing} the +command `\<letters>' instead of typesetting it. +Since auto mode is somewhat dangerous, you have to start it explicitly +by &\AutoCmdSyntaxVerb. You can end it by &\EndAutoCmdSyntaxVerb.\par} + +Auto mode is motivated by the observation that there are package files +containing their documentation as pure (well-readable) ASCII +text---containing the names of the new commands without any kind of +quotation marks or verbatim commands. +Auto mode should typeset such documentation just from the same ASCII +text. + +\item[Hash mark &# comes verbatim.] +No macro definitions are expected in the `document' +environment.\footnote{This idea recently appeared on the 'latex-l' +mailing list. It may be wrong, not sure at the moment, think of +'latexa.ltx' .\,.\,.} +Rather, \lq`#'\rq\ is an active character for taking the next +character (assuming it is a digit) to form a reference to a +\emph{macro parameter}---\lq`#1'\rq\ becomes \lq#1\rq\ (WYSIWYG +indeed!). +\end{description} + +\subsection{What is Wrong with the Present Version} +\begin{enumerate} +\item +'niceverb.sty' should be an extension of 'wiki.sty'; +yet their font selection mechanisms are currently not compatible. +\item +Font switching or horizontal spacing may fail in certain situations with +parentheses. (You can correct spacing by \lq`\ '\rq.) +\item +The feature of mixing high-quality-typeset comments into the +package code listing is implemented in a very rudimentary way only. +% just allowing for `\subsection's. +The ``comment detector'' detects Wikipedia-style subsection titles +instead of lines beginning with percent characters.\footnote{% +Percent characters will definitely not be ``ignored'' as with &\DocInput, +rather they will hide rests of \emph{documentation} lines as usually, +while they will be typeset verbatim in \emph{package code} lines.} +% Switching between plain and verbatim typesetting in the package +% listings isn't settled yet, since there are different styles of using +% percent symbols. I have sometimes used double percent symbols +% (\lq\verb|%%|\rq) +% for commenting text and single ones just for ``reversible deletion of +% code,'' while usually single percent symbols indicate commenting text +% indeed. Double percent symbols may, by contrast, mean that the text remains +% visible in the `.sty' file only, suppressed in the typeset +% documentation ('lineno.sty'). +% For a while, it may be necessary to provide replacing macros for each +% package separately instead of providing a single macro package +% managing all of them. +\item +The code listing currently uses the `listing' and `listingcont' +environments of 'moreverb.sty'; +the code font and the line numbers may be too large. +\item +The ``vertical'' character \lq`|'\rq\ should be active and provide a +version of the `decl' environment of 'ltxguide.cls'. +\end{enumerate} + +\section{Implementation of the Markup Syntax} +% \verbatiminput{niceverb.sty} +% \listinginput[5]{1}{niceverb.sty} +\input{niceverb.doc} + +\section{Code Preparing Source for Typesetting} +This is at present in a file `makedoc.tex'. +\listinginput[5]{1}{makedoc} +\end{document} diff --git a/Master/texmf-dist/doc/latex/nicetext/niceverb.pdf b/Master/texmf-dist/doc/latex/nicetext/niceverb.pdf Binary files differnew file mode 100644 index 00000000000..51bd438d453 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/niceverb.pdf diff --git a/Master/texmf-dist/doc/latex/nicetext/wikicheat.pdf b/Master/texmf-dist/doc/latex/nicetext/wikicheat.pdf Binary files differnew file mode 100644 index 00000000000..481c7e314d4 --- /dev/null +++ b/Master/texmf-dist/doc/latex/nicetext/wikicheat.pdf |