|
|
|||
Why you should write a guide/howto in XML
Several of the howto's/guides I have written I wrote in XML.. You can consider this XML file as a source file.
With a XSLT file you can compile/transform this XML source file into another format. I have one to produce Vbulletin formatting and another XSLT file produces HTML. Advantage is that you need only once source file. The Vbulletin version can be pasted into a post in the Guides section. The HTML version you can attach to the post for downloading. That way people can easily print your HTML formatted guide from a browser. For example see http://www.bsdforums.org/forums/showthread.php?t=50433 where the first three posts are text formatted with Vbulletin tags. In the fourth and last post you can download the HTML version. The Vbulletin version has these CVS tags Code:
$Id: new-iso-itis.xml,v 1.11 2007/06/27 04:41:19 j65nko Exp $ $Id: vbul-html.xsl,v 1.6 2007/06/27 04:49:57 j65nko Exp $ Code:
Id: new-iso-itis.xml,v 1.11 2007/06/27 04:41:19 j65nko Exp $ $Id: howto.xsl,v 1.7 2007/06/27 01:04:44 j65nko Exp $ Before I write a guide about writing a guide using this method, I would like to have some feedback from others. So if somebody is interested in playing with this stuff then please let me know.
__________________
You don't need to be a genius to debug a pf.conf firewall ruleset, you just need the guts to run tcpdump |
|
||||
txt2tags is also very nice, I made a patch to support bbcode (-t bbcode), I attached the patch (and the test document I used) in this message.
The advantage txt2tags has over XSLT is that it's a lot easier (And still works pretty well). Another thing I'm working on is making the guide section a wiki, I'm using dokuwiki as a backend, I'm working on integrating it a bit with vB. ... so this will also affect things, adding new output syntax to txt2tags is fairly simply, I'm not familiar with XSLT so I can't say anything about that...
__________________
UNIX was not designed to stop you from doing stupid things, because that would also stop you from doing clever things. |
|
||||
When I write documents, I generally use TeX with LaTeX macros. I also like that I can have the .tex files converted into many formats and can use a bit of Make+Perl for automating and tweaking outputs.
I'm fluent in XHTML and used to use XHTML+CSS as a replacement for word processors (which finally pissed me off enough to stop using for all but viewing docs). But, I've come to using TeX/LaTeX for different reasons hehe. When I write some thing for a forum though, I normally keep strictly to Bulletin Board Code ;-)
__________________
My Journal Thou shalt check the array bounds of all strings (indeed, all arrays), for surely where thou typest ``foo'' someone someday shall type ``supercalifragilisticexpialidocious''. |
Thread Tools | |
Display Modes | |
|
|
Similar Threads | ||||
Thread | Thread Starter | Forum | Replies | Last Post |
/tmp on ram write denied | gosha | OpenBSD General | 8 | 29th March 2009 04:46 PM |
I've read the installation guide...but! | wubrgamer | FreeBSD General | 5 | 20th September 2008 02:37 PM |
[F1] write usb modem driver | raixun | Programming | 7 | 17th July 2008 11:06 AM |
Guide for KDE over SSH from Vista | ua549 | FreeBSD General | 13 | 13th June 2008 07:20 PM |
[VSFTPD] Can't write in directory | Sunsawe | General software and network | 7 | 1st June 2008 11:29 PM |