<html>
<!-- Some XPS logic is hidden here! -->
<head>
<title>The XPJ articles format</title>
<link rel="stylesheet" type="text/css" href="/style/xpj.css">
<link rel="schema.DC" href="http://dublincore.org/qdcmes/1.0/"
title="DCMES plus DCMI recommended qualifiers">
<link rel="schema.PJ.Subjects"
href="http://www.pluto.linux.it/journal/xpj/schema/subjects"
title="PLUTO Journal Schema: Subjects">
<meta name="DC.Publisher" content="PLUTO Free Software Users Group">
<meta name="DC.Creator" content="Marco Marongiu">
<meta name="DC.Creator" content="Marina Sturino">
<meta name="DC.Language" schema="RFC1766" content="it-IT">
<meta name="DC.Title" content="The XPJ articles format">
<meta name="DC.Date" schema="W3CDTF" content="2002-01-25">
<meta name="DC.Identifier" content="XPJ Specification, version 0">
<meta name="DC.Subject" schema="schema.PJ.Subjects" content="PLUTOWare">
<meta name="DC.Type" content="Technical Article">
<meta name="DC.Contributor" content="Nicola Fragale">
<meta name="DC.Contributor" content="Germano Rizzo">
<meta name="DC.Contributor" content="The PLUTO Journal Staff">
<meta name="DC.Subject" content="keywords, META tags, dc:subject, code tag, listing tag, keyword, link tag, url attribute, id attribute, tables, appendix tag, bio tag, emph tag, sup tag, sub tag">
</head>
<body>
<h1>The XPJ articles format</h1>
<p class="author">di: Marco Marongiu, Marina Sturino.</p>
<hr>
<h2>Sommario</h2>
<div class="abstract">
<p>
This document describes the XPJ documentation format. XPJ is an
XML format specially suited for writing technical articles. Articles
may be published on the world wide web in a variety of formats:
HTML, XHTML, PDF(TM), PostScript(TM), LaTeX, plain text, RDF, RSS
and, obviously, XML :-)
</p>
</div>
<hr>
<h2>Indice</h2>
<div class="index">
<br><a href="#1">1. This title can contain PCDATA</a>
<br><a href="#2">2. Chapters can have sections, too</a>
<ul>
<li><a href="#2.1">2.1. Embedding code in articles</a></li>
</ul>
<br><a href="#3">3. Lists</a>
<br><a href="#4">4. Links and anchors</a>
<br><a href="#5">5. What about tables</a>
<br><a href="#6">6. Figures blocks</a>
<br><a href="#7">7. Other chapter-like sections</a>
<br><a href="#A">A. Other toys</a>
<ul>
<li><a href="#A.1">A.1. Style modifiers</a></li>
<li><a href="#A.2">A.2. Footnotes</a></li>
</ul>
<br><a href="#biblio">Bibliografia</a>
</div>
<hr>
<h2><a name="1">1. This title can contain PCDATA</a></h2>
<p>
We write the title into an element, so that we can use parsed
entities<sup><small><a href="#note1" name="enty">1</a></small></sup>.
If we write as an attribute value, we must use CDATA
only, and we don't want it!
</p>
<p>Text should be written in paragraphs, using the p tag.</p>
<p>
We have a tag to emphasize <span class="keyword">keywords</span>, so that they can
be used by (XSLT, XPathScript,...) stylesheets to compose
<span class="keyword">META tags</span> in HTML, <span class="keyword">dc:subject</span> tags in RDF and
so on.
</p>
<h2><a name="2">2. Chapters can have sections, too</a></h2>
<p>Yes, they really do!</p>
<h3><a name="2.1">2.1 Embedding code in articles</a></h3>
<p>
Short, inline sections of <code>computer code</code>, like
commands for example, are marked using the <span class="keyword">code
tag</span>. Longer blocks of code should use the <span class="keyword">listing
tag</span> instead. For example:
</p>
<code><pre>
#!/bin/bash
# This section of code should be written as-is
# It is good practice to put it inside a [CDATA[...] section
# to avoid character escaping.
# How a system administrator makes love:
touch me
make love
more sex
yes please
</pre></code>
<h2><a name="3">3. Lists</a></h2>
<p>
You can have lists, even nested lists. Lists can contain PCDATA,
keywords, emphasis or links and anchors. No other elements are
allowed.
</p>
<ul>
<li>first item</li>
<li>second item</li>
<ul>
<li>second.first item</li>
<li>second.second item</li>
<li>item with a <span class="keyword">keyword</span></li>
</ul>
<li>third item</li>
</ul>
<h2><a name="4">4. Links and anchors</a></h2>
<p>
We have the <span class="keyword">link tag</span> to create links,
<a href="http://www.pluto.linux.it">like this</a>, for
example. We use the <span class="keyword">url attribute</span> to create
links and <a name="sample_anchor">the <span class="keyword">id
attribute</span></a> to create anchors, which we could
<a href="#sample_anchor">refer to</a>.
</p>
<h2><a name="5">5. What about tables</a></h2>
<p>
Yes, XPJ has <span class="keyword">tables</span>, too! Let's see:
</p>
<div align="center"><table cellpadding="0" cellspacing="0">
<tr>
<th colspan=2>Writers</th>
</tr>
<tr>
<th rowspan=2>XPJ writers</th>
<td>Marco Marongiu</td>
</tr>
<tr>
<td>Marina Sturino</td>
</tr>
</table></div>
<h2><a name="6">6. Figures blocks</a></h2>
<div align="center"><table cellspacing="0" cellpadding="0">
<tr align="center"><td><a name="image.jpg"><img src="image.jpg"></a></td><td><a name="another.jpg"><img src="another.jpg"></a></td></tr>
<tr><th><span class="caption">Figura 1: A small caption here</span></th><th><span class="caption">Figura 2: Another figure, another
caption</span></th></tr>
</table></div>
<h2><a name="7">7. Other chapter-like sections</a></h2>
<p>
You have the <span class="keyword">appendix tag</span> for appendix chapters. All
tags that are valid into chapters tag are allowed into appendix.
</p>
<p>
You also have the <span class="keyword">bio tag</span>, for authors' biographies.
</p>
<h2><a name="A">Appendice A</a><br>Other toys</h2>
<h3><a name="A.1">A.1 Style modifiers</a></h3>
<ul>
<li>Use the <span class="keyword">emph tag</span> to <em>emphasize
text</em>;</li>
<li>use the <span class="keyword">sup tag</span> for <sup><small>superscripts</small></sup>;</li>
<li>use the <span class="keyword">sub tag</span> for <sub><small>subscripts</small></sub></li>
</ul>
<h3><a name="A.2">A.2 Footnotes</a></h3>
<p>
Yes, you have footnotes<sup><small><a href="#note2" name="need">2</a></small></sup>. You should be thankful about it! <!-- :-) -->
</p>
<hr>
<h2><a name="biblio">Bibliografia</a></h2><div class="biblio">
<p><span class="bib_authors">Someone, Someone else</span>: <span class="bib_title">Mastering the shift key</span>; Uncle SAMS<br>
<!-- a subset of DC-like elements allowed here:
* author
* publisher
* HREF (CAZZO! Come si chiamava l'elemento del DC???) -->
Description of this book goes here...
</p>
<p><span class="bib_authors">Mr.Moonlight</span>: <span class="bib_title">Understanding CTRL-ALT-CANC</span>; Follow the QUE<br>
<!-- No description -->
</p>
</div>
<hr>
<h3>Note</h3>
<p class="note"><sup><small><a name="note1" href="#enty">1</small></sup></a> You can't imagine how disappointing is to
find that your attribute values don't show up right after the
XML document has been transformed!</p>
<p class="note"><sup><small><a name="note2" href="#need">2</small></sup></a> we know you need
them</p>
<hr>
<p class="bio"><img src="myface.jpg" align="left">
<!-- Just one small paragraph of PCDATA, thanks -->
Marco Marongiu is just another perl hacker. Don't contact him, he
is nasty!
<br clear="left"></p><p class="bio">
Marina Sturino is just another XSLT hacker.
<a href="mailto:mari@trifida.it">Contact her instead!</a>
</p>
<hr>
<p class="contrib">Hanno collaborato: <a href="mailto:nicolafragale@libero.it">Nicola Fragale</a>, <a href="mailto:mano@pluto.linux.it">Germano Rizzo</a>, The PLUTO Journal Staff.</p>
</body>
</html>