CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/ydoc

README.md

The ydoc class and packages

Copyright (c) 2011-2022 by Martin Scharrer <martin.scharrer@web.de> License: LPPL v1.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 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 distribution ( Live, Mik, ...) and then is installable using the distributions package manager ( 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 (not ):

tex ydoc.dtx

To build the documentation compile the same file using (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\<username>\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}

Download the contents of this package in one zip archive (341.5k).

ydoc – Macros for documentation of classes and packages

The package provides macros and environments to document packages and classes. It is an (as yet unfinished) alternative to the ltxdoc class and the doc or xdoc packages. The aim is to provide a different layout and more modern styles (using the xcolor, hyperref packages, etc.)

This is an alpha release, and should probably not (yet) be used with other packages, since the implementation might change. Nevertheless, the author uses it to document his own packages.

Packageydoc
Home pagehttps://github.com/MartinScharrer/ydoc
Bug trackerhttps://github.com/MartinScharrer/ydoc/issues
Repositoryhttps://github.com/MartinScharrer/ydoc.git
Version0.7alpha 2022-10-26
LicensesThe Project Public License 1.3c
Copyright2011–2022 Martin Scharrer
MaintainerMartin Scharrer
TDS archiveydoc.tds.zip
Contained inTeX Live as ydoc
MiKTeX as ydoc
TopicsDocumentation support
Macro Demonstration
Class
See alsodoc
codedoc
showexpl
gmdoc
xdoc
nicetext
ltxdoc
...
Guest Book Sitemap Contact Contact Author