ASPN ActiveState Programmer Network
ActiveState
/ Home / Perl / PHP / Python / Tcl / XSLT /
/ Safari / My ASPN /
Cookbooks | Documentation | Mailing Lists | Modules | News Feeds | Products | User Groups


Recent Messages
List Archives
About the List
List Leaders
Subscription Options

View Subscriptions
Help

View by Topic
ActiveState
.NET Framework
Open Source
Perl
PHP
Python
Tcl
Web Services
XML & XSLT

View by Category
Database
General
SOAP
System Administration
Tools
User Interfaces
Web Programming
XML Programming


MyASPN >> Mail Archive >> phpdoc
phpdoc
[PHP-DOC] RFC: acronyms.xml
by Philip Olson other posts by this author
Jun 28 2006 1:10PM messages near this date
[PHP-DOC] cvs: phpdoc /entities acronyms.xml | Re: [PHP-DOC] RFC: acronyms.xml
Hello everyone!

This RFC is for a new acronyms.xml and has two main points:

1. File location in phpdoc:

Choices:
  a) /phpdoc/
  b) /phpdoc/entities/
  c) /phpdoc/somenewdir/
  d) ...

Although it's not really a list of entities the file can go in that  
folder. It would be the simplest. Note: this file is not language  
specific so only one copy will exist.

2. The DocBook markup:

I chose a variablelist as it's pretty straightforward. Another option  
is to use glossentry but it adds complexities that we don't really  
need. Example:

<section id="acronyms"> 
<title> Acronyms List</title>
<variablelist> 
   <varlistentry> 
    <term> ASCII</term>
    <listitem> 
     <simpara> American Standard Code for Information Interchange</ 
simpara> 
    </listitem> 
   </varlistentry> 
   <varlistentry> 
    <term> RFC</term>
    <listitem> 
     <simpara> Request For Comments</simpara>
    </listitem> 
   </varlistentry> 
  </variablelist> 
</section> 

Why acronyms.xml? It replaces our use of <acronym>  (in XML) with the  
appropriate <acronym title="...">  in generated HTML.

Please comment with what you think. A concern is whether we need to  
worry about having multiple meanings for one acronym but it seems we  
can ignore that for now as the manual will most likely use only one  
meaning.  And btw, the above has now been implemented in Livedocs :-)

Regards,
Philip
Thread:
Philip Olson
Gabor Hojtsy
Nuno Lopes

Privacy Policy | Email Opt-out | Feedback | Syndication
© ActiveState Software Inc. All rights reserved