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 :-)
We write the title into an element, so that we can use parsed entities1. If we write as an attribute value, we must use CDATA only, and we don't want it!
Text should be written in paragraphs, using the p tag.
We have a tag to emphasize keywords, so that they can be used by (XSLT, XPathScript,...) stylesheets to compose META tags in HTML, dc:subject tags in RDF and so on.
Yes, they really do!
Short, inline sections of computer code
, like
commands for example, are marked using the code
tag. Longer blocks of code should use the listing
tag instead. For example:
#!/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
You can have lists, even nested lists. Lists can contain PCDATA, keywords, emphasis or links and anchors. No other elements are allowed.
We have the link tag to create links, like this, for example. We use the url attribute to create links and the id attribute to create anchors, which we could refer to.
Yes, XPJ has tables, too! Let's see:
Writers | |
---|---|
XPJ writers | Marco Marongiu |
Marina Sturino |
You have the appendix tag for appendix chapters. All tags that are valid into chapters tag are allowed into appendix.
You also have the bio tag, for authors' biographies.
Yes, you have footnotes2. You should be thankful about it!
Mastering the shift key; Uncle SAMS
Description of this book goes here...
Understanding CTRL-ALT-CANC; Follow the QUE
1 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!
2 we know you need them
Marco Marongiu is just another perl hacker. Don't contact him, he
is nasty!
Marina Sturino is just another XSLT hacker. Contact her instead!
Hanno collaborato: Nicola Fragale, Germano Rizzo, The PLUTO Journal Staff.