LDP
/
old-www
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity
old-www/LDP/LDP-Author-Guide/html/metadata-markup.html

706 lines
10 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML
><HEAD
><TITLE
>Markup for Metadata</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="LDP Author Guide"
HREF="index.html"><LINK
REL="UP"
TITLE="DocBook: Sample Markup"
HREF="using-docbook.html"><LINK
REL="PREVIOUS"
TITLE="Inserting Pictures"
HREF="inserting-pictures.html"><LINK
REL="NEXT"
TITLE="Bibliographies"
HREF="doc-bib.html"></HEAD
><BODY
CLASS="section"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>LDP Author Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="inserting-pictures.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Appendix D. DocBook: Sample Markup</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="doc-bib.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="metadata-markup"
></A
>D.6. Markup for Metadata</H1
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="crediting"
></A
>D.6.1. Crediting Translators, Converters and Co-authors</H2
><P
>There are several ways that these folks, as well as other
contributors to your document, can be given some recognition for
the help they've given you.</P
><DIV
CLASS="section"
><H3
CLASS="section"
><A
NAME="crediting-othercredit"
></A
>D.6.1.1. <TT
CLASS="sgmltag"
>&#60;othercredit&#62;</TT
></H3
><P
>All translators, converters and co-authors
should be credited with an
<TT
CLASS="sgmltag"
>&#60;othercredit&#62;</TT
> tag entry.
To properly credit a translator or converter, use the <TT
CLASS="sgmltag"
>&#60;othercredit&#62;</TT
> tag with
the <TT
CLASS="sgmltag"
>role</TT
>
attribute set to <SPAN
CLASS="QUOTE"
>"converter"</SPAN
> or
<SPAN
CLASS="QUOTE"
>"translator"</SPAN
>,
as indicated in the example below:</P
><DIV
CLASS="example"
><A
NAME="ex-othercredit"
></A
><P
><B
>Example D-8. Other Credit</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="screen"
>&#13;<TT
CLASS="sgmltag"
>&#60;othercredit role='converter'&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;firstname&#62;</TT
>David<TT
CLASS="sgmltag"
>&#60;/firstname&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;surname&#62;</TT
>Merrill<TT
CLASS="sgmltag"
>&#60;/surname&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;contrib&#62;</TT
>Conversion from HTML to DocBook v3.1 (SGML).<TT
CLASS="sgmltag"
>&#60;/contrib&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/othercredit&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><H3
CLASS="section"
><A
NAME="crediting-editors"
></A
>D.6.1.2. Crediting Editors and Reviewers</H3
><P
>&#13; To help track the review process all new documents must include a
reference to the reviewers for the <A
HREF="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/techreview.html"
TARGET="_top"
>technical</A
>,
<A
HREF="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/languagereview.html"
TARGET="_top"
>language</A
>
and <A
HREF="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/metadatareview.html"
TARGET="_top"
>metadata</A
>
reviews.
</P
><DIV
CLASS="example"
><A
NAME="ex-editor"
></A
><P
><B
>Example D-9. Editor</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="screen"
>&#13;<TT
CLASS="sgmltag"
>&#60;editor&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;firstname&#62;</TT
>Tabatha<TT
CLASS="sgmltag"
>&#60;/firstname&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;surname&#62;</TT
>Marshall<TT
CLASS="sgmltag"
>&#60;/surname&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;contrib&#62;</TT
>Language review of version 0.8<TT
CLASS="sgmltag"
>&#60;/contrib&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/editor&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="crediting-version"
></A
>D.6.2. <TT
CLASS="sgmltag"
>&#60;revremark&#62;</TT
>s</H2
><P
>Within the <TT
CLASS="sgmltag"
>&#60;revision&#62;</TT
>
tag hierarchy is a tag called <TT
CLASS="sgmltag"
>&#60;revremark&#62;</TT
>. Within this tag,
you can make any brief notes you wish about each
particular revision of your document.</P
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="acceptedrev"
></A
>D.6.3. Revision History</H2
><P
> The <TT
CLASS="sgmltag"
>&#60;revhistory&#62;</TT
> tag should be used to denote
the various revisions of the document. Specify the date, revision
number and comments regarding what has changed.</P
><P
>&#13; Revisions should be listed with the most-recent version at the
top (list in descending order).
</P
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="accepteddates"
></A
>D.6.4. Date formats</H2
><P
> The <TT
CLASS="sgmltag"
>&#60;pubdate&#62;</TT
> tag in your header should list
the publication date of this particular version of the document
(coincide with the revision date). It should be in the following
format: </P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
><TT
CLASS="sgmltag"
>&#60;pubdate&#62;</TT
>2002-04-25<TT
CLASS="sgmltag"
>&#60;/pubdate&#62;</TT
></PRE
></FONT
></TD
></TR
></TABLE
><P
>&#13; The date is in the format YYYY-MM-DD, which is one of the <A
HREF="http://www.w3.org/TR/NOTE-datetime"
TARGET="_top"
>ISO 8601</A
>
standard formats for representing dates. For you Yanks out
there (me too), think of it as going from the largest unit of
time to the smallest.
</P
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="sampleai"
></A
>D.6.5. Sample Article (or Book) Information Element</H2
><P
> Here is a sample of a complete DocBook (SGML or XML)
<TT
CLASS="sgmltag"
>&#60;articleinfo&#62;</TT
> element
which contains some of the items and constructs previously
described. </P
><DIV
CLASS="example"
><A
NAME="sample-metadata"
></A
><P
><B
>Example D-10. Sample Meta Data</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;&#60;!--
Above these lines in a typical DocBook article would be the article
element (the immediate parent of the articleinfo element) and above
that typically, the DOCTYPE declaration and internal subset.
--&#62;
<TT
CLASS="sgmltag"
>&#60;articleinfo&#62;</TT
>
&#60;!--
Use "HOWTO", "mini HOWTO", "FAQ" in title, if appropriate
--&#62;
<TT
CLASS="sgmltag"
>&#60;title&#62;</TT
>Sample HOWTO<TT
CLASS="sgmltag"
>&#60;/title&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;author&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;firstname&#62;</TT
>Your Firstname<TT
CLASS="sgmltag"
>&#60;/firstname&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;surname&#62;</TT
>Your Surname<TT
CLASS="sgmltag"
>&#60;/surname&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;affiliation&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;address&#62;</TT
><TT
CLASS="sgmltag"
>&#60;email&#62;</TT
>your email<TT
CLASS="sgmltag"
>&#60;/email&#62;</TT
><TT
CLASS="sgmltag"
>&#60;/address&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/affiliation&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/author&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;editor&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;firstname&#62;</TT
>Tabatha<TT
CLASS="sgmltag"
>&#60;/firstname&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;surname&#62;</TT
>Marshall<TT
CLASS="sgmltag"
>&#60;/surname&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;contrib&#62;</TT
>Language review of version 0.8<TT
CLASS="sgmltag"
>&#60;/contrib&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/editor&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;othercredit role='converter'&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;firstname&#62;</TT
>David<TT
CLASS="sgmltag"
>&#60;/firstname&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;surname&#62;</TT
>Merrill<TT
CLASS="sgmltag"
>&#60;/surname&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;contrib&#62;</TT
>Conversion from HTML to DocBook v3.1 (SGML).<TT
CLASS="sgmltag"
>&#60;/contrib&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/othercredit&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;pubdate&#62;</TT
>YYYY-MM-DD<TT
CLASS="sgmltag"
>&#60;/pubdate&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;revhistory&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;revision&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;revnumber&#62;</TT
>1.0<TT
CLASS="sgmltag"
>&#60;/revnumber&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;date&#62;</TT
>YYYY-MM-DD<TT
CLASS="sgmltag"
>&#60;/date&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;authorinitials&#62;</TT
>ABC<TT
CLASS="sgmltag"
>&#60;/authorinitials&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/revremark&#62;</TT
>first official release<TT
CLASS="sgmltag"
>&#60;/revremark&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/revision&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;revision&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;revnumber&#62;</TT
>0.9<TT
CLASS="sgmltag"
>&#60;/revnumber&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;date&#62;</TT
>YYYY-MM-DD<TT
CLASS="sgmltag"
>&#60;/date&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;authorinitials&#62;</TT
>ABC<TT
CLASS="sgmltag"
>&#60;/authorinitials&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;revremark&#62;</TT
>First draft<TT
CLASS="sgmltag"
>&#60;/revremark&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/revision&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/revhistory&#62;</TT
>
&#60;!--
Provide a good abstract; a couple of sentences is sufficient
--&#62;
<TT
CLASS="sgmltag"
>&#60;abstract&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;para&#62;</TT
>
This is a sample DocBook (SGML or XML) HOWTO which has been
constructed to serve as a template.
<TT
CLASS="sgmltag"
>&#60;/para&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/abstract&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/articleinfo&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="inserting-pictures.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="doc-bib.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Inserting Pictures</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="using-docbook.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Bibliographies</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Reference in New Issue View Git Blame Copy Permalink