XML mastering for &LaTeX; document classes... <author>... <copyright>... <releaseinfo>http://latex.silmaril.ie/packages/</releaseinfo> <annotation>... <abstract>... <revhistory>... </info> \end{lstlisting} % \iffalse %</ignore> % \fi % Of these, the \texttt{<cover>}\index{cover=\texttt{\char'074 cover\char'076 } (element)}\index{elements:!cover=\texttt{\char'074 cover\char'076 }} element is the most % complex, as it is used to hold all the details of % packages and settings required for the class or package % \emph{and} for the production of the % documentation. It therefore gets the whole of % \vref{packages} to itself.\par % The other metadata element types within the % \texttt{<cover>}\index{cover=\texttt{\char'074 cover\char'076 } (element)}\index{elements:!cover=\texttt{\char'074 cover\char'076 }} element are more obvious, and use the % conventional \emph{DocBook} % structure.\par % \begin{description}[style=unboxed] % \item[\texttt{<title>}\index{title=\texttt{\char'074 title\char'076 } (element)}\index{elements:!title=\texttt{\char'074 title\char'076 }}:]This contains the title of your class or package in % natural language.\par % This is \emph{not} the content of % the \LaTeX{} {\ttfamily{}\textbackslash{}title} command in the % {\ttfamily{}.dtx} file, which is automatically % preset to the standard phrase `The % \textsf{\uline{name}} % \LaTeXe{} document class' (or % `package') where % \uline{name} is the name of your % class or package as specified in the \texttt{@xml:id}\index{xml:id=\texttt{\char'100 xml:id} (attribute)}\index{attributes:!xml:id=\texttt{\char'100 xml:id}} attribute of the % \texttt{<book>}\index{book=\texttt{\char'074 book\char'076 } (element)}\index{elements:!book=\texttt{\char'074 book\char'076 }} root element.\par % The title you give in % \emph{this}~\texttt{<title>}\index{title=\texttt{\char'074 title\char'076 } (element)}\index{elements:!title=\texttt{\char'074 title\char'076 }} % element is the explanatory % \emph{subtitle} which appears % \emph{under} the automatically-generated % one on the first page of the typeset % documentation.\par % \item[\texttt{<author>}\index{author=\texttt{\char'074 author\char'076 } (element)}\index{elements:!author=\texttt{\char'074 author\char'076 }}:]The \texttt{<author>}\index{author=\texttt{\char'074 author\char'076 } (element)}\index{elements:!author=\texttt{\char'074 author\char'076 }} element provides identity % markup for the author[s], using a % \texttt{<personname>}\index{personname=\texttt{\char'074 personname\char'076 } (element)}\index{elements:!personname=\texttt{\char'074 personname\char'076 }} element for each author, % containing subelements for firstname, surname, and % other forms of naming; optionally followed by an % \texttt{<affiliation>}\index{affiliation=\texttt{\char'074 affiliation\char'076 } (element)}\index{elements:!affiliation=\texttt{\char'074 affiliation\char'076 }} element, where you can identify % employer or other status; address; email; and % \textsc{uri}, as in the following example. % The name, affiliation, and email address are used in % the {\ttfamily{}\textbackslash{}author} command of the % {\ttfamily{}.dtx} file.\par % \iffalse %<*ignore> % \fi \begin{lstlisting}[language=XML] <author role="maintainer"> <personname> <firstname>Peter</firstname> <surname>Flynn</surname> </personname> <affiliation> <orgname>Silmaril Consultants</orgname> <orgdiv>Textual Therapy Division</orgdiv> </affiliation> <address>Cork, Ireland</address> <email>peter@silmaril.ie</email> <uri>http://blogs.silmaril.ie/peter</uri> <contrib role="sponsor">UCC</contrib> </author> \end{lstlisting} % \iffalse %</ignore> % \fi % For multiple authors, you must enclose multiple % \texttt{<author>}\index{author=\texttt{\char'074 author\char'076 } (element)}\index{elements:!author=\texttt{\char'074 author\char'076 }} elements (one per author) in an % \texttt{<authorgroup>}\index{authorgroup=\texttt{\char'074 authorgroup\char'076 } (element)}\index{elements:!authorgroup=\texttt{\char'074 authorgroup\char'076 }} container element, for example:\par % \iffalse %<*ignore> % \fi \begin{lstlisting}[language={[LaTeX]TeX}] <authorgroup> <author role="maintainer"> ... </author> <author> ... </author> ...etc... </authorgroup> \end{lstlisting} % \iffalse %</ignore> % \fi % At least one % of the authors must be identified as the maintainer of % the package or class, by adding the \texttt{<role>}\index{role=\texttt{\char'074 role\char'076 } (element)}\index{elements:!role=\texttt{\char'074 role\char'076 }} % attribute with the value \texttt{"maintainer"}\index{maintainer=\texttt{"maintainer"} (attribute value)}\index{attribute values:!maintainer=\texttt{"maintainer"}}.\par % A \texttt{<contrib>}\index{contrib=\texttt{\char'074 contrib\char'076 } (element)}\index{elements:!contrib=\texttt{\char'074 contrib\char'076 }} element with a \texttt{@role}\index{role=\texttt{\char'100 role} (attribute)}\index{attributes:!role=\texttt{\char'100 role}} attribute set to \texttt{"sponsor"}\index{sponsor=\texttt{"sponsor"} (attribute value)}\index{attribute values:!sponsor=\texttt{"sponsor"}} can be added in an % \texttt{<author>}\index{author=\texttt{\char'074 author\char'076 } (element)}\index{elements:!author=\texttt{\char'074 author\char'076 }} block, to give the % name of an organisation sponsoring the development of % the class or package.\par % \item[\texttt{<copyright>}\index{copyright=\texttt{\char'074 copyright\char'076 } (element)}\index{elements:!copyright=\texttt{\char'074 copyright\char'076 }}:]This element lets you identify the \texttt{<year>}\index{year=\texttt{\char'074 year\char'076 } (element)}\index{elements:!year=\texttt{\char'074 year\char'076 }} % and the name of the \texttt{<holder>}\index{holder=\texttt{\char'074 holder\char'076 } (element)}\index{elements:!holder=\texttt{\char'074 holder\char'076 }} (you, your % employer, or some other entity).\par % \iffalse %<*ignore> % \fi \begin{lstlisting}[language=XML] <copyright> <year YYYY-MM-DD="2020"/> <holder>ACME Consulting</holder> </copyright> \end{lstlisting} % \iffalse %</ignore> % \fi % \item[\texttt{<releaseinfo>}\index{releaseinfo=\texttt{\char'074 releaseinfo\char'076 } (element)}\index{elements:!releaseinfo=\texttt{\char'074 releaseinfo\char'076 }}:]In the absence of other ways of identifying where % to find your class or package (assuming it will % eventually find its way onto \textsc{ctan}\index{CTAN}), % this element can be used to hold the % \textsc{uri} of a location where it can be % downloaded, such as your personal or business web % site.\par % \item[\texttt{<annotation>}\index{annotation=\texttt{\char'074 annotation\char'076 } (element)}\index{elements:!annotation=\texttt{\char'074 annotation\char'076 }}:]This element is used for a warning or notice you % want placed in the Preamble of the % {\ttfamily{}.ins} file, which is used for % extracting your class or package from the % {\ttfamily{}.dtx} file, where it will be seen % by users installing the software.\par % \par\begingroup % \fboxsep1em\centering % \fbox{\begin{minipage}{0.8\columnwidth}\sffamily % \raggedright\parindent0pt % \parskip=.5\baselineskip % This use case of \texttt{<annotation>}\index{annotation=\texttt{\char'074 annotation\char'076 } (element)}\index{elements:!annotation=\texttt{\char'074 annotation\char'076 }} in this % location is \emph{different} from the % one described in \vref{annotatedcode}.\par % \end{minipage}}\par\endgroup % \item[\texttt{<abstract>}\index{abstract=\texttt{\char'074 abstract\char'076 } (element)}\index{elements:!abstract=\texttt{\char'074 abstract\char'076 }}:]The Abstract is formatted on the front page of % your documentation. Like any abstract, it should % summarise what the class or package does, and who % might want to use it.\par % The \texttt{<abstract>}\index{abstract=\texttt{\char'074 abstract\char'076 } (element)}\index{elements:!abstract=\texttt{\char'074 abstract\char'076 }} element % {\sffamily \textsc{may}} start with an % optional \texttt{<title>}\index{title=\texttt{\char'074 title\char'076 } (element)}\index{elements:!title=\texttt{\char'074 title\char'076 }} element, which (if present) % will be used to change the value of the % {\ttfamily{}\textbackslash{}abstractname} in the % {\ttfamily{}.dtx} file % (`Summary' is a common % choice).\par % The rest of the abstract is basically just % paragraphs; note that lists, block quotations, % figures, tables, etc cannot be used in a % \emph{DocBook} Abstract.\par % \item[\texttt{<revhistory>}\index{revhistory=\texttt{\char'074 revhistory\char'076 } (element)}\index{elements:!revhistory=\texttt{\char'074 revhistory\char'076 }}:]\label{revhist}This holds the top-level information about each % major and minor revision, outlining the main changes. % The version number of the most recent revision, as % identified by the latest value of the \texttt{@YYYY-MM-DD}\index{YYYY-MM-DD=\texttt{\char'100 YYYY-MM-DD} (attribute)}\index{attributes:!YYYY-MM-DD=\texttt{\char'100 YYYY-MM-DD}} attribute of the % \texttt{<date>}\index{date=\texttt{\char'074 date\char'076 } (element)}\index{elements:!date=\texttt{\char'074 date\char'076 }} element, % {\sffamily \textsc{must}} match the version % number composed from the major version and the % revision in the \texttt{<book>}\index{book=\texttt{\char'074 book\char'076 } (element)}\index{elements:!book=\texttt{\char'074 book\char'076 }} root element % attributes (see ‘\textbf{\textsf{\texttt{@revision}\index{revision=\texttt{\char'100 revision} (attribute)}\index{attributes:!revision=\texttt{\char'100 revision}}}}’, the fifth item in the list in \vref{revno}).\par % \changes{v1.18}{2020/04/01}{This changed from the conformance attribute to the YYYY-MM-DD attribute. Updated all master documents.} % \iffalse %<*ignore> % \fi \begin{lstlisting}[language=XML] <revision version="0.72"> <date YYYY-MM-DD="2012-02-11"/> <revdescription> <itemizedlist> <title>Wrote internal documentation

}\index{section=\texttt{\char'074 section\char'076 } (element)}\index{elements:!section=\texttt{\char'074 section\char'076 }}, % \texttt{}\index{subsection=\texttt{\char'074 subsection\char'076 } (element)}\index{elements:!subsection=\texttt{\char'074 subsection\char'076 }}, etc; % \item[Floats:]floating objects like \texttt{

File	Description
`- . .zip`	Zip file of the CTAN distribution
`- . .tds.zip`	TeX Directory Structure (TDS) zipfile
`.dtx`	Doc combined code and documentation
`.ins`	Doc installer
`.pdf`	PDF documentation
`.`	the file
`.png`	associated image

style packages and document classes from Silmaril

The package

v . of © – LPPL 1.3c