summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/xelatex/unisugar/unisugar.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/xelatex/unisugar/unisugar.tex')
-rw-r--r--Master/texmf-dist/doc/xelatex/unisugar/unisugar.tex62
1 files changed, 53 insertions, 9 deletions
diff --git a/Master/texmf-dist/doc/xelatex/unisugar/unisugar.tex b/Master/texmf-dist/doc/xelatex/unisugar/unisugar.tex
index 32f4c516383..e1df1d8d23f 100644
--- a/Master/texmf-dist/doc/xelatex/unisugar/unisugar.tex
+++ b/Master/texmf-dist/doc/xelatex/unisugar/unisugar.tex
@@ -1,6 +1,8 @@
-\documentclass{ltxdoc} % Process with xelatex
+\documentclass{ltxdoc} % Process with xelatex -shell-esc
\usepackage{unisugar}
\usepackage[colorlinks=true]{hyperref}
+\usepackage{bashful}
+\usepackage{varioref}
⌘let⌘use␣package=⌘usepackage
⌘use␣package{xspace}
@@ -58,8 +60,40 @@ This work consists of the files ⌘texttt{⌘me.tex} and ⌘texttt{⌘me.sty}
⌘date{{⌘makeatletter
⌘date@unisugar\thanks{
This document describes ⌘unisugar ⌘version@unisugar.}}}
+
+
⌘begin{document}
+⌘bash[stdoutFile=README]
+cat << EOF
+The unisugar package 0.92
+=========================
+
+This package requires a TeX-alike system that uses native Unicode input system;
+current examples are XeTeX and LuaTeX. The package provides syntactic sugar for
+selected LaTeX commands, allowing these to be replaced with their Unicode-
+character counterpart, e.g., a Unicode bullet can be used instead of a \item,
+and a pilcrow can be used instead of \paragraph.
+
+The intent is to minimize the use of English left-to-right characters in
+documents whose main language is written right-to-left, since mixing characters
+of different directionality confuses both text editors and human beings.
+
+Using this package, you may find yourself typing a bit less, provided you can
+configure your text editor or keyboard driver to generate the handful of Unicode
+characters defined by this package. More importantly, the package is useful in
+defining macros whose name is composed of right-to-left characters and in
+minimizing mixed directionality text in right-to-left documents.
+
+This package may be distributed and/or modified under the LaTeX Project Public
+License (LPPL), version 1.3 or higher (your choice). The latest version of this
+license can be found at: http://www.latex-project.org/lppl.txt
+
+This work is author-maintained(as per LPPL maintenance status) by Yossi Gil
+<yogi@cs.Technion.ac.IL>
+EOF
+\END
+
⌘maketitle
⌘begin{abstract}
This package provides syntactic sugar
@@ -228,7 +262,7 @@ As the cursor moves forward beginning at the first character in
expect it to proceed to the adjacent
letter ⌘texthebrew{א}.
This so called ⌘emph{visual} flow is
- in fact incorrect.
+ in incorrect.
The more correct ⌘emph{logical} flow prescribes
that the cursor should instead ``jump'' to the
to the letter ⌘texthebrew{מ}, which is the first letter of
@@ -294,9 +328,9 @@ This might be confusing even further since the section body will,
⌘begin{figure}[!htbp]
⌘begin{center}
- \includegraphics[scale=0.3]{traditional.png}
+ ⌘includegraphics[scale=0.3]{traditional.png}
⌘end{center}
-\caption{Using traditional sectioning directive with right-to-left text}
+⌘caption{Using traditional sectioning directive with right-to-left text}
⌖{Figure:traditional}
⌘end{figure}
@@ -347,11 +381,11 @@ Still, four more ⌘Unicode characters are used by ⌘unisugar
⌘begin{enumerate}
• Code point 2022, the bullet, rendered as ⌘•, is
yet another name for the ⌘verb+\item+ command.
- In fact, to obtain this item, I typed
+To obtain this item, I typed
⌘begin{code}
\• Code point 2022, the bullet, rendered as ⌘textbackslash\•,⏎
is yet another name for the ⌘verb-\verb+\item+- command.⏎
- In fact, to obtain this item, I typed:⏎
+ To obtain this item, I typed:⏎
⌘end{code}
• Code point 23CE, the return symbol, rendered
as~⌘return␣key is an alias for ⌘verb+\\+.
@@ -383,6 +417,10 @@ is yet another name for the ⌘verb-\verb+\item+- command.⏎
To reference Table {\fontspec{DejaVu Sans Mono}\☝}\{Table:divisions\},
I wrote
⌘end{code}
+
+• Code point 2026 (horizontal ellipsis), rendered as \verb+…+, serves as a sugar nickname for
+ \verb+\ldots+, the lower ellipsis command.
+
⌘end{enumerate}
@@ -433,8 +471,8 @@ The intention is that it will serve for separating words
several words.
-The names of large number of ⌘LaTeX{} commands are made
- from two words
+The names of a large number of ⌘LaTeX{} commands are made
+ from two words.
There are even a dozen or so control sequences whose
name consists of three words, e.g., ⌘verb+\enlargethispage+
and ⌘verb+\addcontentsline+.
@@ -645,7 +683,8 @@ With ⌘texttt{sukkar}
§ History
⌘begin{description}
•[Version 0.9] Initial release.
-•[Version 0.91] Placed under
+•[Version 0.91] Placed under LPPL.
+•[Version 0.92] Added U+2026 HORIZONTAL ELLIPSIS, as nickname for ⌘verb+\ldots+.
⌘end{description}
@@ -660,4 +699,9 @@ Martin Scharrer and Will Robertson encouraged me to work on this package.
Vafa Khalighi
devotion to bidirectional text processing with ⌘LaTeX{}
was truly inspirational.
+
+
+
+
+
⌘end{document}