diff options
author | Karl Berry <karl@freefriends.org> | 2022-04-04 20:54:49 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2022-04-04 20:54:49 +0000 |
commit | 656055251bead88e4d7e7d685722255033367f49 (patch) | |
tree | 6c5f28eb221ee4213fc5ef8b6211eb464f5992a2 /Master/texmf-dist/doc/latex/projlib | |
parent | 4ca1cb3da46997c41eff1ae88aad0d090f717b3c (diff) |
jxu (4apr22)
git-svn-id: svn://tug.org/texlive/trunk@62900 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/projlib')
-rw-r--r-- | Master/texmf-dist/doc/latex/projlib/README.md | 135 |
1 files changed, 39 insertions, 96 deletions
diff --git a/Master/texmf-dist/doc/latex/projlib/README.md b/Master/texmf-dist/doc/latex/projlib/README.md index cfac379f40a..ab478f4771d 100644 --- a/Master/texmf-dist/doc/latex/projlib/README.md +++ b/Master/texmf-dist/doc/latex/projlib/README.md @@ -4,32 +4,13 @@ # The `ProjLib` Toolkit -The bundle is dated 2022/03/21 +> **ProjLib** can be interpreted as "***Proj**ect **Lib**rary*" (in English), or as "***Proj**et **Lib**re*" (in French, meaning "*Free Project*"). -## **Important note** - -The whole project is being rewritten with `expl3`. The new modules are basically finished but are **not yet documented**. They have filenames with the prefix `projlib-`, and they are in many ways better and more powerful than their predecessors. - -The new modules are: -- projlib-author -- projlib-datetime -- projlib-draft -- projlib-font -- projlib-language -- projlib-logo -- projlib-math -- projlib-paper -- projlib-theorem - -Below is the old README. - ---- - -> **ProjLib** can be interpreted as "***Proj**ect **Lib**rary*" (in English), or as "***Proj**et **Lib**re*" (in French). +**This bundle is dated 2022/04/03. Please note that the documentations are not yet up-to-date.** ## Introduction -`ProjLib` is a collection of tools that help you write LaTeX document. With the package `ProjLib` loaded (note that it is case-sensitive), you no longer need to set up the theorem-like environments nor to manually configure the appropriate multilingual settings. In addition, a series of auxiliary functionalities are introduced. +`ProjLib` is a collection of tools that help you write LaTeX document. With the main package `ProjLib` loaded (note that it is *case-sensitive*), you no longer need to manually configure the appropriate multilingual settings nor to set up the theorem-like environments. In addition, a series of auxiliary functionalities are introduced. To get started, simply put this line in your preamble: ```latex @@ -37,38 +18,45 @@ To get started, simply put this line in your preamble: ``` > For the options and detailed usage, please refer to the documentation. -## The components -The components include: -1. `PJLauthor.sty` - - Enhanced author information block - - Offers `\address`, `\curraddr` and `\email` - - Write in the AMS fashion (with option `amsfashion`): + +## The modules + +> Each module correspond to a separate package, for example, the module `theorem` is `projlib-theorem.sty`. + +The modules include: +1. module `author` - *Enhanced author information block* + - Offering `\address`, `\curraddr` and `\email`. + - Write in the AMS fashion (with option `ams-fashion`): - Support `\dedicatory`, `\keywords` and `\subjclass` - `\thanks` can be written outside `\author`; - The `abstract` environment can be placed before `\maketitle`. -1. `PJLdate.sty` - - Offers a macro `\PLdate` (or `\PJLdate`) to convert `yyyy-mm-dd` to normal datetime format, with multi-language support -1. `PJLdraft.sty` - - Useful macros during the draft stage: `\dnf` and `\needgraph`, with multi-language support -1. `PJLlang.sty` - - Multi-language configuration based on `babel` or `polyglossia` - - Offers `\UseLanguage`, `\UseOtherLanguage` and `\AddLanguageSetting` - - Currently support Chinese (simplified and traditional), English, French, German, Italien, Japanese, Portuguese (European and Brazilian), Russian and Spanish -1. `PJLlogo.sty` - - Draw the ProjLib logo -1. `PJLmath.sty` - - Useful math macros and shortcuts -1. `PJLpaper.sty` - - Paper style configuration: yellow theme, dark theme and nord theme -1. `PJLthm.sty` - - Theorem setup and configuration - - Offers a macro `\CreateTheorem` for creating theorem-like environments with multi-language support - - Preset environments include: `assumption`, `axiom`, `conjecture`, `convention`, `corollary`, `definition`, `definition-proposition`, `definition-theorem`, `example`, `exercise`, `fact`, `hypothesis`, `lemma`, `notation`, `observation`, `problem`, `property`, `proposition`, `question`, `remark`, `theorem`, and the corresponding unnumbered version with an asterisk `*` in the name. -1. `PJLtoolkit.sty` (this is the internal name of the `ProjLib` package) - - A collective interface of ProjLib Toolkit, loading all the packages above - - Provide some pre-defined font configuration - -> Since `PJLthm.sty` (and thus `ProjLib.sty`) uses `cleveref`, it should be loaded after `varioref` and `hyperref`. +1. module `datetime` - *Convert numeric date-time string to natural language* + - `\TheDate` and `\Thedate` for converting numeric date-time string to natural language, with multi-language support (if the command names `\TheDate` or `\Thedate` are occupied, then one can switch to the longer version `\ProjLibDate` and `\ProjLibdate`). + - `\ProjLibToday` and `\ProjLibToday` (with the module `language` enabled, `\today` is redefined into `\ProjLibToday`, and thus supports the arguments like `only-year-month`). + - Multiple input and output format available. +1. module `draft` - *Useful commands during draft stage* + - `\DNF` for marking unfinished part. In addition, a report of all unfinished places shall be printed at the last of your document. +1. module `font` - *Font selection and configuration* + - Supporting Palatino, Times, Garamond, Biolinum, Noto, etc. +1. module `language` - *Multi-language configuration* + - `\UseLanguage`, `\UseOtherLanguage` for selecting languages, and `\AddLanguageSetting` for adding language-specific settings. + - `\DefineMultilingualText` for defining multilingual text strings. + - Currently support Chinese (simplified and traditional), English, French, German, Italien, Japanese, Portuguese (European and Brazilian), Russian and Spanish. +1. module `logo` - *The ProjLib logo* + - Draw the `ProjLib` logo in colorful or colorless fashion. +1. module `math` - *Efficient math setup* + - `\DefineOperator` and `\DefineShortcut` for setting up math macros efficiently + - `\ListOfSymbols` for printing list of symboks +1. module `paper` - *Configuration of the paper style* + - Paper style configuration, with the themes `yellow`, `green`, `light gray`, `gray`, `dark`, etc. +1. module `theorem` - *Configuration of theorem-like environments* + - `\CreateTheorem`, `\SetTheorem` and more: setting up theorem-like environments based on the package `create-theorem`, and in particular, supporting the modes `name as is` and `name as context` for referencing names + - Support options `simple name` and `complex name` for referencing names + - Preset environments include: `assertion`, `assumption`, `axiom`, `conclusion`, `conjecture`, `convention`, `corollary`, `definition`, `definition-proposition`, `definition-theorem`, `example`, `exercise`, `fact`, `hypothesis`, `lemma`, `notation`, `observation`, `postulate`, `problem`, `property`, `proposition`, `question`, `remark`, `theorem`, and the corresponding unnumbered version with an asterisk `*` in the name. +1. module `titlepage` - *Commands for rendering the title page* + - Currently support two title page styles: `default` and `simple`. + +> Since the module `theorem` uses `cleveref`, it should be loaded after `varioref` and `hyperref` (same for the main package `ProjLib`). ## How to get these files You can get the `.sty` files mentioned above simply by compiling `ProjLib.ins`: @@ -88,51 +76,6 @@ It is recommended to use `latexmk` with option `-xelatex`: latexmk -xelatex ProjLib-doc-**.tex ``` -## An example -```latex -\documentclass{amsart} -\usepackage[a4paper,margin=.75in]{geometry} -\usepackage[hidelinks]{hyperref} -\usepackage[palatino]{ProjLib} - -%% You can also comment the above lines and try the following (require xelatex or lualatex): -% \documentclass[a4paper,allowbf]{lebhart} -% \usepackage[amsfashion]{ProjLib} - -%% Using \UseLanguage to select language, by default "English" is selected -\UseLanguage{French} % Use French from here - -\begin{document} - -\title{Le Titre} -\author{Auteur 1} -\address{Adresse 1} -\email{\href{Courriel 1}{Courriel 1}} -\author{Auteur 1} -\address{Adresse 1} -\email{\href{Courriel 2}{Courriel 2}} -\date{\PLdate{2022-04-01}} -\subjclass{*****} -\keywords{...} - -\begin{abstract} - Ceci est un résumé. \dnf<Some hint> -\end{abstract} - -\maketitle - -\section{Un théorème} - -%% Theorem-like environments can be used directly -\begin{theorem}\label{thm:abc} - Ceci est un théorème. -\end{theorem} - -Référence du théorème: \cref{thm:abc} % It is recommended to use clever reference - -\end{document} -``` - # License This work is released under the LaTeX Project Public License, v1.3c or later. |