Go Back   DaemonForums > Miscellaneous > Guides

Guides All Guides and HOWTO's.

Thread Tools Display Modes
  #1   (View Single Post)  
Old 7th May 2008
J65nko J65nko is offline
Join Date: May 2008
Location: Budel - the Netherlands
Posts: 3,699
Default 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
$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 $
The HTML version has
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 $
Notice the identical CVS tags for the new-iso-itis.xml source file while the *xsl files are different.

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
Reply With Quote
  #2   (View Single Post)  
Old 7th May 2008
Carpetsmoker's Avatar
Carpetsmoker Carpetsmoker is offline
Real Name: Martin
Tcpdump Spy
Join Date: Apr 2008
Location: Indonesia
Posts: 2,226

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...
Attached Files
File Type: t2t bbcode.t2t (1.9 KB, 50 views)
File Type: diff txt2tags.diff (5.7 KB, 49 views)
UNIX was not designed to stop you from doing stupid things, because that would also stop you from doing clever things.
Reply With Quote
  #3   (View Single Post)  
Old 7th May 2008
TerryP's Avatar
TerryP TerryP is offline
Arp Constable
Join Date: May 2008
Location: USofA
Posts: 1,547

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''.
Reply With Quote
  #4   (View Single Post)  
Old 27th August 2008
BuSerD's Avatar
BuSerD BuSerD is offline
Real Name: Alejandro
Noob In Training
Join Date: Aug 2008
Location: Houston, TX
Posts: 14

I find the topic intriguing and I've wanted to set aside the time to learn LaTeX for some time. The only thing I worry about is that we geeks sometimes bypass ease of use for geek cred. I'm guilty as charged
Reply With Quote
  #5   (View Single Post)  
Old 19th October 2008
mdh's Avatar
mdh mdh is offline
Real Name: Matt D. Harris
FreeBSD 2.2.6 User
Join Date: Oct 2008
Location: West Virginia
Posts: 139

Interesting; I've been using the heck out of xml2rfc of late and it really does simplify production of an ID/RFC format document by allowing you to lay things out in a very ordered manner.
Reply With Quote

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump

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

All times are GMT. The time now is 08:56 AM.

Powered by vBulletin® Version 3.8.4
Copyright ©2000 - 2021, Jelsoft Enterprises Ltd.
Content copyright © 2007-2010, the authors
Daemon image copyright ©1988, Marshall Kirk McKusick