diff options
author | Karl Berry <karl@freefriends.org> | 2022-11-01 19:50:40 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2022-11-01 19:50:40 +0000 |
commit | bb0b72659a9f57a4d360f919a7b00ade0d533030 (patch) | |
tree | 158b578054b8522e1498c5a006d54b97479b5739 /Master/texmf-dist/doc/latex/ydoc | |
parent | aa6046aa8081d7aa6edd54c8ae2b746331548803 (diff) |
ydoc (1nov22)
git-svn-id: svn://tug.org/texlive/trunk@64887 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/ydoc')
-rw-r--r-- | Master/texmf-dist/doc/latex/ydoc/DEPENDS.txt | 13 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/ydoc/README.md (renamed from Master/texmf-dist/doc/latex/ydoc/README) | 38 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/ydoc/ydoc.pdf | bin | 327049 -> 340225 bytes |
3 files changed, 37 insertions, 14 deletions
diff --git a/Master/texmf-dist/doc/latex/ydoc/DEPENDS.txt b/Master/texmf-dist/doc/latex/ydoc/DEPENDS.txt new file mode 100644 index 00000000000..a0206831038 --- /dev/null +++ b/Master/texmf-dist/doc/latex/ydoc/DEPENDS.txt @@ -0,0 +1,13 @@ +hard newverbs +hard hyperref +hard needspace +hard xcolor +hard listings +hard shortvrb +hard etoolbox +hard xspace +hard url +hard showexpl +hard float + +soft needspace diff --git a/Master/texmf-dist/doc/latex/ydoc/README b/Master/texmf-dist/doc/latex/ydoc/README.md index 42216bd3c89..cb886a08f7b 100644 --- a/Master/texmf-dist/doc/latex/ydoc/README +++ b/Master/texmf-dist/doc/latex/ydoc/README.md @@ -1,29 +1,37 @@ -The 'ydoc' class and packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -'ydoc' provides macros and environments to document LaTeX packages and classes. -It is an alternative to the 'ltxdoc' class and 'doc' package. -It targets a different layout and tries to provide more modern styles (xcolor, hyperref, etc.). +The `ydoc` class and packages +============================= +Copyright (c) 2011-2022 by Martin Scharrer <martin.scharrer@web.de> +License: [LPPL v1.3c](https://www.latex-project.org/lppl/lppl-1-3c/) +CTAN: https://www.ctan.org/pkg/ydoc +Texdoc: https://texdoc.org/pkg/ydoc +Homepage: https://github.com/MartinScharrer/ydoc +Repository: https://github.com/MartinScharrer/ydoc.git +Issue tracker: https://github.com/MartinScharrer/ydoc/issues + +`ydoc` provides macros and environments to document LaTeX packages and classes. +It is an alternative to the `ltxdoc` class and `doc` package. +It targets a different layout and tries to provide more modern styles (`xcolor`, `hyperref`, etc.). This is an alpha release. It should not be used yet for other packages. INSTALL -~~~~~~~ +------- This package might be part of your LaTeX distribution (TeX Live, MikTeX, ...) and then is installable using -the distributions package manager (TeX Live: 'tlmgr install ydoc'). +the distributions package manager (TeX Live: `tlmgr install ydoc`). However, it is also manually installable using the following ways: -1) TDS ZIP FILE +### TDS ZIP FILE ### + A TDS ZIP file includes all files in a installable format and using the required directory structure. Simply unzip the TDS ZIP file over your TEXMF tree. - The TDS ZIP file can be downloaded from CTAN: http://mirrors.ctan.org/install/macros/latex/contrib/ydoc.tds.zip -2) DTX FILE -The 'ydoc.dtx' file includes all required files, which can be extracted by compiling it using TeX (not LaTeX): +### DTX FILE ### + +The `ydoc.dtx` file includes all required files, which can be extracted by compiling it using TeX (not LaTeX): tex ydoc.dtx @@ -34,8 +42,9 @@ To build the documentation compile the same file using LaTeX (preferable 'pdflat pdflatex ydoc.dtx Copy all files to their correct location of your local TEXMF tree. -For example under Linux a personal TEXMF is normally located at '~/texmf' ('$HOME/texmf'). -The files can be installed using the following Linux commands. For +For example under Linux a personal TEXMF is normally located at `~/texmf` (`$HOME/texmf`) +and under Windows usually under `C:\Users\<username>\texmf`. +The files can be installed using the following Linux commands: mkdir -p "${TEXMF}/tex/latex/ydoc/" mkdir -p "${TEXMF}/source/latex/ydoc/" @@ -50,3 +59,4 @@ Update the tree database file (might be not required for modern versions and per texhash ${TEXMF} + diff --git a/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf b/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf Binary files differindex fb097616b79..be805174c4d 100644 --- a/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf +++ b/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf |