diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/bxjalipsum/README.md')
-rw-r--r-- | Master/texmf-dist/doc/latex/bxjalipsum/README.md | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/bxjalipsum/README.md b/Master/texmf-dist/doc/latex/bxjalipsum/README.md new file mode 100644 index 00000000000..d6af25ae9bf --- /dev/null +++ b/Master/texmf-dist/doc/latex/bxjalipsum/README.md @@ -0,0 +1,78 @@ +BXjalipsum Package +================== + +LaTeX: Dummy text in Japanese + +This package enables users to print some Japanese text that can be used +as dummy text. It is a Japanese counterpart of the lipsum package. + +Since there is no well-known nonsense text like Lipsum in the Japanese +language, the package uses some real text in public domain. + +### System requirement + + * TeX format: LaTeX. + * TeX engine: pTeX / upTeX / XeTeX / LuaTeX. + * Dependent packages: + - intcalc (when using non-e-TeX engines) + +### Installation + + - `*.sty` → $TEXMF/tex/latex/BXjalipsum + +### License + +This package is distributed under the MIT License. + +The bxjalipsum Package +---------------------- + +### Package Loading + + \usepackage{bxjalipsum} + +No options are available. + +### Usage + + * `\jalipsum[<range>,...]{<key>}`: Prints some paragraphs from the + text specified by the key. + + - `iroha` (1 paragraph): The iroha sequence (いろはにほへと…). + - `jugemu` (1 paragraph): The "jugemu" name (寿限無寿限無五劫の…). + - `jugemuP` (1 paragraph): The "jugemu" name, with some punctuation + added in ad hoc manner (寿限無・寿限無、五劫の…). + - `wagahai` (33 paragraphs): The first chapter from the novel + "吾輩は猫である" (I Am A Cat) written by Natsume Soseki. + - `preamble` (4 paragraphs): The preamble of the Constitution of + Japan. + - `hatsukoi` (4 paragraphs): The whole text of the poem "初恋" + (First Love) written by Shimazaki Toson. + + Ranges are specified in the form `[-3,7-10,5,12-]`. If ranges are not + given, then `[-]` (all paragraphs) will be assumed. + + * `\jalipsumiroha`: The shorthand for `\jalipsum{iroha}`. + * `\jalipsumjugemu`: The shorthand for `\jalipsum{jugemu}`. + * `\jalipsumjugemuP`: The shorthand for `\jalipsum{jugemuP}`. + +### Notices for the TeX-programmers + + * All the commands are fully expandable. + * The `\jalipsum` command is expanded to the actual text in two steps. + * The shorthand commands such as `\jalipsumiroha` are expanded to the + actual text in one step. + * Each of the paragraph texts consists only of character tokens and + optional `\\` (line-break) tokens. + * When `\jalipsum` with multiple paragraphs is expanded, each paragraph + is joined with `\par` tokens. + +Revision History +---------------- + + * Version 0.2 〈2016/08/15〉 + - The first public version. + +-------------------- +Takayuki YATO (aka. "ZR") +http://zrbabbler.sp.land.to/ |