From bb0b72659a9f57a4d360f919a7b00ade0d533030 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 1 Nov 2022 19:50:40 +0000 Subject: ydoc (1nov22) git-svn-id: svn://tug.org/texlive/trunk@64887 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/ydoc/DEPENDS.txt | 13 ++++++ Master/texmf-dist/doc/latex/ydoc/README | 52 ---------------------- Master/texmf-dist/doc/latex/ydoc/README.md | 62 +++++++++++++++++++++++++++ Master/texmf-dist/doc/latex/ydoc/ydoc.pdf | Bin 327049 -> 340225 bytes 4 files changed, 75 insertions(+), 52 deletions(-) create mode 100644 Master/texmf-dist/doc/latex/ydoc/DEPENDS.txt delete mode 100644 Master/texmf-dist/doc/latex/ydoc/README create mode 100644 Master/texmf-dist/doc/latex/ydoc/README.md (limited to 'Master/texmf-dist/doc/latex') 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 deleted file mode 100644 index 42216bd3c89..00000000000 --- a/Master/texmf-dist/doc/latex/ydoc/README +++ /dev/null @@ -1,52 +0,0 @@ -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.). - -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'). -However, it is also manually installable using the following ways: - -1) 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): - - tex ydoc.dtx - -To build the documentation compile the same file using LaTeX (preferable 'pdflatex') multiple times: - - pdflatex ydoc.dtx - pdflatex ydoc.dtx - 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 - - mkdir -p "${TEXMF}/tex/latex/ydoc/" - mkdir -p "${TEXMF}/source/latex/ydoc/" - mkdir -p "${TEXMF}/doc/latex/ydoc/" - mkdir -p "${TEXMF}/tex/generic/ydoc/" - cp ydoc.sty ydoc.cls ydoc-code.sty ydoc-desc.sty ydoc-doc.sty ydoc-expl.sty ydoc.cfg "${TEXMF}/tex/latex/ydoc" - cp ydoc.dtx ydoc.ins "${TEXMF}/source/latex/ydoc" - cp ydoc.pdf README "${TEXMF}/doc/latex/ydoc" - cp ydocincl.tex ydocstrip.tex "${TEXMF}/tex/generic/ydoc" - -Update the tree database file (might be not required for modern versions and personal TEXMF trees): - - texhash ${TEXMF} - diff --git a/Master/texmf-dist/doc/latex/ydoc/README.md b/Master/texmf-dist/doc/latex/ydoc/README.md new file mode 100644 index 00000000000..cb886a08f7b --- /dev/null +++ b/Master/texmf-dist/doc/latex/ydoc/README.md @@ -0,0 +1,62 @@ +The `ydoc` class and packages +============================= +Copyright (c) 2011-2022 by Martin Scharrer +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`). +However, it is also manually installable using the following ways: + +### 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 + + +### DTX FILE ### + +The `ydoc.dtx` file includes all required files, which can be extracted by compiling it using TeX (not LaTeX): + + tex ydoc.dtx + +To build the documentation compile the same file using LaTeX (preferable 'pdflatex') multiple times: + + pdflatex ydoc.dtx + pdflatex ydoc.dtx + 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`) +and under Windows usually under `C:\Users\\texmf`. +The files can be installed using the following Linux commands: + + mkdir -p "${TEXMF}/tex/latex/ydoc/" + mkdir -p "${TEXMF}/source/latex/ydoc/" + mkdir -p "${TEXMF}/doc/latex/ydoc/" + mkdir -p "${TEXMF}/tex/generic/ydoc/" + cp ydoc.sty ydoc.cls ydoc-code.sty ydoc-desc.sty ydoc-doc.sty ydoc-expl.sty ydoc.cfg "${TEXMF}/tex/latex/ydoc" + cp ydoc.dtx ydoc.ins "${TEXMF}/source/latex/ydoc" + cp ydoc.pdf README "${TEXMF}/doc/latex/ydoc" + cp ydocincl.tex ydocstrip.tex "${TEXMF}/tex/generic/ydoc" + +Update the tree database file (might be not required for modern versions and personal TEXMF trees): + + texhash ${TEXMF} + + diff --git a/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf b/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf index fb097616b79..be805174c4d 100644 Binary files a/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf and b/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf differ -- cgit v1.2.3