Tribeless Nomad (tribelessnomad) wrote in lj_userdoc,
Tribeless Nomad
tribelessnomad
lj_userdoc

Guide formats

To show what the BML and XML formats for Guides look like, I'll write out here a very simple Guide, using each format. This example is a Guide that lists the 4 existing Guides.



Here's a BML version, patterned after Gita's work:
(=PAGE
TITLE=>LiveJournal Guide: List of Guides
BODY<=

(=H1 List of Guides H1=)

(=P
Four Guides have been put online so far. They are listed here.
P=)

(=P
<ul>
<br><li><a href="http://www.livejournal.com/guide/start.bml">Getting Started</a>
<br><li><a href="http://www.livejournal.com/guide/free.bml">Free Accounts</a>
<br><li><a href="http://www.livejournal.com/guide/interests.bml">Interests</a>
<br><li><a href="http://www.livejournal.com/guide/support.bml">Support Policy</a>
</ul>
P=)

(=STANDOUT
(=P
<CENTER>List compiled by (=LJUSER tribelessnomad LJUSER=)</CENTER>
P=)
STANDOUT=)

<=BODY
PAGE=)
... and here's the same document in XML (including several lines of added metadata):
<guide title="List of Guides">

<revstatus>This is only a sample document.</revstatus>
<author username="tribelessnomad" initials="AJW"/>
<revision number="1.0.1" date="June 18, 2001" username="tribelessnomad" initials="AJW">
Updated to reflect changes in how metadata is specified.
</revision>


<section title="List of Guides">

<p>Four Guides have been put online so far. They are listed here.</p>

<p>
<ul>
<li><lj-htdoc page="guide/start.bml">Getting Started</lj-htdoc></li>
<li><lj-htdoc page="guide/free.bml">Free Accounts</lj-htdoc></li>
<li><lj-htdoc page="guide/interests.bml">Interests</lj-htdoc></li>
<li><lj-htdoc page="guide/support.bml">Support Policy</lj-htdoc></li>
</ul>
</p>

</section>

<acknowledge>List compiled by <lj user="tribelessnomad"/></acknowledge>

</guide>
Details of the XML format will appear in a "Guide for authors of LJ Guides", which should be ready within a few weeks. Right now, I just wanted to give everyone a feel for how the Guides look in a text editor.

Update (June 18): The XML sample has been modified to reflect changes in the format.
Subscribe
  • Post a new comment

    Error

    Comments allowed for members only

    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded 

  • 0 comments