summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/zhlipsum
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-01-06 21:54:29 +0000
committerKarl Berry <karl@freefriends.org>2018-01-06 21:54:29 +0000
commit3af3ed68e9471efe28f233a3ac2fe97c2dad1f2c (patch)
treed325bf1c7f28369df2dc9701a45dbeeec1d0f990 /Master/texmf-dist/doc/latex/zhlipsum
parent09d8a2ec38ae288b52a27f8681c3327ef0e58d8b (diff)
zhlipsum (6jan18)
git-svn-id: svn://tug.org/texlive/trunk@46233 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/zhlipsum')
-rw-r--r--Master/texmf-dist/doc/latex/zhlipsum/README.md56
-rwxr-xr-xMaster/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-big5.tex38
-rw-r--r--Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-gbk.tex29
-rw-r--r--Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-utf8.tex29
-rwxr-xr-xMaster/texmf-dist/doc/latex/zhlipsum/zhlipsum-en.pdfbin0 -> 38314 bytes
-rwxr-xr-xMaster/texmf-dist/doc/latex/zhlipsum/zhlipsum-en.tex153
-rw-r--r--Master/texmf-dist/doc/latex/zhlipsum/zhlipsum.pdfbin259679 -> 201988 bytes
7 files changed, 259 insertions, 46 deletions
diff --git a/Master/texmf-dist/doc/latex/zhlipsum/README.md b/Master/texmf-dist/doc/latex/zhlipsum/README.md
index 97bd30b98b6..fd97171db25 100644
--- a/Master/texmf-dist/doc/latex/zhlipsum/README.md
+++ b/Master/texmf-dist/doc/latex/zhlipsum/README.md
@@ -1,29 +1,53 @@
-# zhlipsum - Chinese dummy text
+The `zhlipsum` package
+======================
-[![Build Status](https://travis-ci.org/Stone-Zeng/zhlipsum.svg?branch=master)](https://travis-ci.org/Stone-Zeng/zhlipsum)
-[![CTAN](https://img.shields.io/ctan/v/zhlipsum.svg)](https://www.ctan.org/pkg/zhlipsum)
-[![GitHub release](https://img.shields.io/github/release/Stone-Zeng/zhlipsum/all.svg)](https://github.com/Stone-Zeng/zhlipsum/releases/latest)
+The `zhlipsum` package provides an interface to dummy text in
+Chinese language, which will be useful for testing Chinese
+documents.
-## Introduction
+`zhlipsum` supports UTF-8, GBK and Big5 encodings.
-This pack­age pro­vides an in­ter­face to dummy text in Chi­nese, which
-will be use­ful for test­ing Chi­nese doc­u­ments.
+Basic usage
+-----------
-`zhlipsum` supports both UTF-8 and GBK en­cod­ing.
+ \zhlipsum
+ \zhlipsum*[1-5]
+ \zhlipsum[6-10][script=trad]
-## Basic usage
+More information can be found in the package documentation
+[zhlipsum.pdf](http://mirrors.ctan.org/macros/latex/contrib/zhlipsum/zhlipsum.pdf)
+(Chinese version) or [zhlipsum-en.pdf](http://mirrors.ctan.org/macros/latex/contrib/zhlipsum/zhlipsum-en.pdf)
+(English version).
-```tex
-\zhlipsum[3]
-\zhlipsum*[1-5]
-```
+Installation
+------------
-More information can be found in the package documentation
-[zhlipsum.pdf](http://mirrors.ctan.org/macros/latex/contrib/zhlipsum/zhlipsum.pdf).
+To install `zhlipsum`, you can use one of the following methods:
+
+- If you are running TeX Live, the simplest way is to run
+
+ tlmgr install zhlipsum
+
+- Download
+ [zhlipsum.tds.zip](http://mirror.ctan.org/install/macros/latex/contrib/zhlipsum.tds.zip)
+ from CTAN, extract it in the root of one of your TDS trees, and
+ update the filename database.
-## License
+Contributing
+------------
+
+[Issues](https://github.com/Stone-Zeng/zhlipsum/issues) and
+[pull requests](https://github.com/Stone-Zeng/zhlipsum/pulls)
+are always welcome.
+
+License
+-------
This work may be distributed and/or modified under the conditions of
the [LaTeX Project Public License](http://www.latex-project.org/lppl.txt),
either version 1.3c of this license or (at your option) any later
version.
+
+-----
+
+Copyright (C) 2017, 2018 by Xiangdong Zeng <pssysrq@163.com>.
diff --git a/Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-big5.tex b/Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-big5.tex
new file mode 100755
index 00000000000..67e7707748e
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-big5.tex
@@ -0,0 +1,38 @@
+%%
+%% This is file `zhlipsum-example-big5.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% zhlipsum.dtx (with options: `example,big5')
+%%
+\documentclass{article}
+\usepackage{CJK}
+\usepackage[encoding=big5]{zhlipsum}
+\begin{document}
+\begin{CJK*}{Bg5}{bsmi}
+\def\parcmd{\texttt{\textbackslash par}}
+\section{Basic}
+\zhlipsum
+\section{Simplified / traditional}
+\subsection{Simplified}
+\zhlipsum[1-3][script=simp]
+\subsection{Traditional}
+\zhlipsum*[1-3][script=trad]
+\subsection{Simplified}
+\zhlipsum[4-5]
+\section{Single paragraph}
+\zhlipsum[55]
+\section{With `\parcmd'}
+Some text before lorem ipsum.
+\zhlipsum[0-2]
+Some text after lorem ipsum.
+\section{Without `\parcmd'}
+Some text before lorem ipsum.
+\zhlipsum*[0-500]
+Some text after lorem ipsum.
+\end{CJK*}
+\end{document}
+%%
+%%
+%% End of file `zhlipsum-example-big5.tex'.
diff --git a/Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-gbk.tex b/Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-gbk.tex
index ebf7a0cf30b..d8d02462691 100644
--- a/Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-gbk.tex
+++ b/Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-gbk.tex
@@ -4,33 +4,32 @@
%%
%% The original source files were:
%%
-%% zhlipsum.dtx (with options: `ex-gbk')
+%% zhlipsum.dtx (with options: `example,gbk')
%%
\documentclass[GBK]{ctexart}
-\usepackage[encoding=GBK]{zhlipsum}
+\usepackage[encoding=gbk]{zhlipsum}
\begin{document}
\def\parcmd{\texttt{\textbackslash par}}
-
\section{Basic}
\zhlipsum
-
+\section{Simplified / traditional}
+\subsection{Simplified}
+\zhlipsum[1-3][script=simp]
+\subsection{Traditional}
+\zhlipsum*[1-3][script=trad]
+\subsection{Simplified}
+\zhlipsum[4-5]
\section{Different fonts}
-{\songti \zhlipsum[1]}
-
-{\heiti \zhlipsum[2]}
-
-{\fangsong \zhlipsum[3]}
-
-{\kaishu \zhlipsum[4]}
-
+{\songti \zhlipsum[1]} \par
+{\heiti \zhlipsum[2]} \par
+{\fangsong \zhlipsum[3]} \par
+{\kaishu \zhlipsum[4]} \par
\section{Single paragraph}
\zhlipsum[55]
-
\section{With `\parcmd'}
Some text before lorem ipsum.
-\zhlipsum[0-1]
+\zhlipsum[0-2]
Some text after lorem ipsum.
-
\section{Without `\parcmd'}
Some text before lorem ipsum.
\zhlipsum*[0-500]
diff --git a/Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-utf8.tex b/Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-utf8.tex
index 17eae9d2af2..2132a604a03 100644
--- a/Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-utf8.tex
+++ b/Master/texmf-dist/doc/latex/zhlipsum/example/zhlipsum-example-utf8.tex
@@ -4,33 +4,32 @@
%%
%% The original source files were:
%%
-%% zhlipsum.dtx (with options: `ex-utf8')
+%% zhlipsum.dtx (with options: `example,utf8')
%%
\documentclass[UTF8]{ctexart}
-\usepackage[encoding=UTF8]{zhlipsum}
+\usepackage[encoding=utf8]{zhlipsum}
\begin{document}
\def\parcmd{\texttt{\textbackslash par}}
-
\section{Basic}
\zhlipsum
-
+\section{Simplified / traditional}
+\subsection{Simplified}
+\zhlipsum[1-3][script=simp]
+\subsection{Traditional}
+\zhlipsum*[1-3][script=trad]
+\subsection{Simplified}
+\zhlipsum[4-5]
\section{Different fonts}
-{\songti \zhlipsum[1]}
-
-{\heiti \zhlipsum[2]}
-
-{\fangsong \zhlipsum[3]}
-
-{\kaishu \zhlipsum[4]}
-
+{\songti \zhlipsum[1]} \par
+{\heiti \zhlipsum[2]} \par
+{\fangsong \zhlipsum[3]} \par
+{\kaishu \zhlipsum[4]} \par
\section{Single paragraph}
\zhlipsum[55]
-
\section{With `\parcmd'}
Some text before lorem ipsum.
-\zhlipsum[0-1]
+\zhlipsum[0-2]
Some text after lorem ipsum.
-
\section{Without `\parcmd'}
Some text before lorem ipsum.
\zhlipsum*[0-500]
diff --git a/Master/texmf-dist/doc/latex/zhlipsum/zhlipsum-en.pdf b/Master/texmf-dist/doc/latex/zhlipsum/zhlipsum-en.pdf
new file mode 100755
index 00000000000..6f88ed94b31
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/zhlipsum/zhlipsum-en.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/zhlipsum/zhlipsum-en.tex b/Master/texmf-dist/doc/latex/zhlipsum/zhlipsum-en.tex
new file mode 100755
index 00000000000..991f7bc8782
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/zhlipsum/zhlipsum-en.tex
@@ -0,0 +1,153 @@
+%%
+%% This is file `zhlipsum-en.tex',
+%% generated with Lua script `get-doc-en.lua'.
+%%
+%% The original source files were:
+%%
+%% zhlipsum.dtx
+%%
+%% Copyright (C) 2017, 2018 by Xiangdong Zeng <pssysrq@163.com>
+%%
+%% This work may be distributed and/or modified under the
+%% conditions of the LaTeX Project Public License, either
+%% version 1.3c of this license or (at your option) any later
+%% version. The latest version of this license is in:
+%%
+%% http://www.latex-project.org/lppl.txt
+%%
+%% and version 1.3 or later is part of all distributions of
+%% LaTeX version 2005/12/01 or later.
+%%
+%% This work has the LPPL maintenance status `maintained'.
+%%
+%% The Current Maintainer of this work is Xiangdong Zeng.
+%%
+%% This work consists of the file zhlipsum.dtx,
+%% and the derived files zhlipsum.ins,
+%% zhlipsum.sty,
+%% zhlipsum-utf8.def,
+%% zhlipsum-gbk.def,
+%% zhlipsum-big5.def,
+%% zhlipsum-example-utf8.tex,
+%% zhlipsum-example-gbk.tex,
+%% zhlipsum-example-big5.tex,
+%% zhlipsum-en.tex,
+%% zhlipsum.pdf,
+%% zhlipsum-en.pdf,
+%% and README.md.
+%%
+\PassOptionsToPackage{scheme=plain, linespread=1.1}{ctex}
+\documentclass{ctxdoc}
+\hypersetup{
+ pdftitle = {zhlipsum: Chinese dummy text},
+ pdfauthor = {Xiangdong Zeng},
+ bookmarksnumbered = true
+}
+\geometry{
+ ignoremp,
+ hmargin = {2.00 in, 1.00 in},
+ vmargin = {1.25 in, 1.00 in},
+ marginpar = 1.75 in
+}
+\ctexset
+ {
+ section = {name = {}, format+ = \raggedright},
+ subsubsection/tocline = {\CTEXnumberline{#1}#2}
+ }
+\pagestyle{headings}
+
+\title{\textbf{The \pkg{zhlipsum} Package: Chinese Dummy Text}}
+\author{Xiangdong Zeng}
+\date{2018/01/06 \quad v0.5%
+ \thanks{\url{https://github.com/Stone-Zeng/zhlipsum}.}}
+
+\begin{document}
+
+\maketitle
+
+\section{Introduction}
+
+The \pkg{zhlipsum} package is used for typing in dummy text
+(i.e.\ ``\emph{Lorem ipsum}'') as \pkg{lipsum},
+\pkg{kantlipsum}, \pkg{blindtext} etc., but for Chinese
+language. Dummy text will be useful when testing the effect of
+page style.
+
+\pkg{zhlipsum} supports UTF-8, GBK and Big5 encodings. Packages
+\pkg{expl3}, \pkg{xparse} and \pkg{l3keys2e} in the \LaTeX3{}
+Project are required. To type Chinese properly, \pkg{zhlipsum}
+should be used with \pkg{CJK} package or \CTeX{} bundle.
+
+\section{User's guide}
+
+\begin{function}[added=2017-09-16,updated=2018-01-05]{encoding}
+ \begin{syntax}
+ encoding = <(utf8)|gbk|big5>
+ \end{syntax}
+ Package option for selecting encoding. Default value is
+ \opt{utf8}. For Unicode engines as \XeLaTeX{}, \LuaLaTeX{} ands \XeLaTeX{}, \LuaLaTeX{} and
+ \upLaTeX{}, \opt{gbk} / \opt{big5} encodings are invalid and
+ \opt{utf8} will be used forcibly.
+\end{function}
+
+In \CTeX{} bundle, the correspoding options are \opt{UTF8} and
+\opt{GBK}. Note that all the options in \pkg{zhlipsum} are in
+\emph{lowercase}.
+
+\begin{function}[updated=2018-01-05]{\zhlipsum}
+ \begin{syntax}
+ \cs{zhlipsum}\oarg{paragraph}\oarg{options}
+ \cs{zhlipsum*}\oarg{paragraph}\oarg{options}
+ \end{syntax}
+ Insert dummy text. Each fragment will be typed as single
+ paragraph (inserting \tn{par} in between) by default. If you
+ want get a big chunk of text without \tn{par}, please use
+ \cs{zhlipsum*}. In both situations, \tn{par} will be inserted
+ before and after the whole dummy text.
+\end{function}
+
+The first optional argument \meta{paragraph} can be specified
+as the following:
+
+\begin{itemize}
+ \item Only one integer, then \cs{zhlipsum} will produce the
+ correspoding paragraph.
+ \item Two integers linked with ``|-|'', then all the
+ paragraphs between will be produced.
+ \item Bare \cs{zhlipsum} will lead to paragraphs 1 to 3 by
+ default.
+\end{itemize}
+
+At present, \pkg{zhlipsum} can provide 50 paragraphs. Numbers
+larger than 50 will not be considered. For example,
+|\zhlipsum[51]| produces paragraph 50, and |\zhlipsum[48-55]|
+produces 48--50 paragraphs.
+
+The second optional argument \meta{options} should be a
+key-value list. If you need set the options, \meta{paragraph}
+must be specified explicitly. Supported options are the
+following.
+
+\begin{function}[added=2018-01-05]{script}
+ \begin{syntax}
+ script = <simp|trad>
+ \end{syntax}
+ Use simplified Chinese (\opt{simp}) or traditional Chinese
+ text (\opt{trad}). Default value is \opt{simp} except for Big5
+ encoding, since this encoding only supports traditional
+ Chinese.
+\end{function}
+
+\section{Known issues}
+
+GBK and Big5 encodings do not escape the ASCII range in the
+second byte, so the second byte of some Chinese characters may
+have the same encoding as special characters in ASCII like |{|,
+|}|, |\| etc., which will lead to compilation failure. The
+\file{.def} files in \pkg{zhlipsum} have been converted into
+a safer form. Please do not modify them manually.
+
+If there is no special requirement, UTF-8 encoding and Unicode
+engines as \XeLaTeX{} and \LuaLaTeX{} are always recommended.
+
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/zhlipsum/zhlipsum.pdf b/Master/texmf-dist/doc/latex/zhlipsum/zhlipsum.pdf
index d84856641ab..0ca9c8d0c1e 100644
--- a/Master/texmf-dist/doc/latex/zhlipsum/zhlipsum.pdf
+++ b/Master/texmf-dist/doc/latex/zhlipsum/zhlipsum.pdf
Binary files differ