Added markup HOWTO for bibliographies.

This commit is contained in:
emmajane 2003-12-12 04:12:18 +00:00
parent a82c837de2
commit f5f72d0c15
1 changed files with 76 additions and 1 deletions

View File

@ -956,7 +956,82 @@ e</sgmltag></programlisting>
<section id="doc-bib">
<title>Bibliographies</title>
<para>notes to come!</para>
<para>
Not everyone will choose to use the correct formatting for a
bibliography. Most will use a list of some kind. And that's ok. But
when you're ready to move to the next level, here's how to do it.
</para>
<para>
Below are two examples of bibliographic entries. The first is a very
simple entry. It has only a title, URL and possibly a short
description (abstract). The second is a little more complex and is
for a full entry (e.g. a book) with an ISBN, publisher and copyright
date.
</para>
<note>
<para>
At least one element within <sgmltag>biblioentry</sgmltag> is
required, but it doesn't matter which one you have. So you might
have a title, or a URL (<sgmltag>bibliosource</sgmltag>), or an
author, or, ...
</para>
</note>
<caution>
<para>
By default <sgmltag>abstract</sgmltag>s do not display on web
pages. You need to modify the <filename>biblio.xsl</filename> file.
Do a search for the word <quote>abstract</quote> and then add
this information inside the &lt;xsl:template&gt; tags. If that
doesn't make sense, don't worry about it too much, but do be
aware that it's required for the abstracts to show up.
</para>
<screen>
&lt;div xmlns=&quot;http://www.w3.org/1999/xhtml&quot; class=&quot;{name(.)}&quot;&gt;
&lt;xsl:apply-templates mode=&quot;bibliography.mode&quot;/&gt;
&lt;/div&gt;
</screen>
</caution>
<example id="ex-bib">
<title>A Bibliography</title>
<screen>
<sgmltag>bibliography</sgmltag>
<sgmltag>title</sgmltag>Bibliography title<sgmltag class="endtag">title</sgmltag>
<sgmltag>bibliodiv</sgmltag>
<sgmltag>title</sgmltag>Section title<sgmltag class="endtag">title</sgmltag>
<sgmltag>biblioentry</sgmltag>
<sgmltag>title</sgmltag>Book or Web Site Title<sgmltag class="endtag">title</sgmltag>
<sgmltag>bibliosource</sgmltag><sgmltag class="emptytag" /><sgmltag class="endtag">bibliosource</sgmltag>
<sgmltag>abstract</sgmltag><sgmltag class="endtag">abstract</sgmltag>
<sgmltag class="endtag">biblioentry</sgmltag>
<sgmltag>biblioentry</sgmltag>
<sgmltag>title</sgmltag><sgmltag class="endtag">title</sgmltag>
<sgmltag>bibliosource</sgmltag><sgmltag>ulink url="" /</sgmltag><sgmltag class="endtag">bibliosource</sgmltag>
<sgmltag>author</sgmltag><sgmltag>firstname</sgmltag><sgmltag class="endtag">firstname</sgmltag><sgmltag>surname</sgmltag><sgmltag class="endtag">surname</sgmltag><sgmltag class="endtag">author</sgmltag>
<sgmltag>copyright</sgmltag><sgmltag>year</sgmltag><sgmltag class="endtag">year</sgmltag>
<sgmltag>holder</sgmltag><sgmltag class="endtag">holder</sgmltag><sgmltag class="endtag">copyright</sgmltag>
<sgmltag>editor</sgmltag><sgmltag>firstname</sgmltag><sgmltag class="endtag">firstname</sgmltag><sgmltag>surname</sgmltag><sgmltag class="endtag">surname</sgmltag><sgmltag class="endtag">editor</sgmltag>
<sgmltag>isbn</sgmltag><sgmltag class="endtag">isbn</sgmltag>
<sgmltag>publisher</sgmltag>
<sgmltag>publishername</sgmltag><sgmltag class="endtag">publishername</sgmltag>
<sgmltag class="endtag">publisher</sgmltag>
<sgmltag>abstract</sgmltag><sgmltag class="endtag">abstract</sgmltag>
<sgmltag class="endtag">biblioentry</sgmltag>
<sgmltag class="endtag">bibliodiv</sgmltag>
<sgmltag class="endtag">bibliography</sgmltag>
</screen>
<para>
View <xref linkend="bibliography" /> to see this in action.
</para>
</example>
</section>
<section id="tools-entities"> <title>Entities (shortcuts,