MediaPortal manual

2004-07-31, 11:03

Very cool. May I suggest :
- using XML (DocBook ?) or HTML as the source format
- issuing this documentation under the GNU FDL license

Thanks to the authors!

2004-08-05, 17:15

Hi Epoch,
At the present time the documentation is being distributed in PDF format, for regional reasons. It was created with A4 LTR size, then converted to US LTR, and then formatting got unwieldy. So for now, it is being created in OpenOffice [.swx], converted to PDF for present distribution, then later an A4 Ltr will probably be produced. Other formats are fine, but too much maintenance at the moment. Once MP is finalized, and a finished document is produced, then we may consider alternative formats.
I guess we just have too much time on our hands! :wink:

Mr.Mitchell · 2004-08-05, 20:44

Actually XML/Docbook sounds like a good idea. That way more people can work on the manual at the same time (if it is in CVS) and if I am not mistaken you can generate documentation in all kinds of formats like PDF for easy printing or HTML to put the documentation online.

2004-08-06, 19:10

Thanks for your interest. Let me rephrase to make my intentions clearer :
a) 1st thing 1st: I think there is need for a licensing scheme that goes well w/ GPL to allow translators (and plugin authors, and....) contributing to the documentation.
b) Opening the doc requires :
- an open format, like HTML or XML to warrant easy access
- a strong structure to make a homogeneous final document from the input of a variety of contributors
c) The final output should be generated from the structured data, hopefully using proven tools. I personnaly like Pdf. I am sure others will want HTML, or RTF...

Hence my Docbook proposal : an XML scheme backed with good document generators (don't know the status on windows).

I could try looking into this if you'd like. I would need the OO source to play with it. Is it in the CVS tree ? Or could you post it on the website ?

Thx in advance.

2004-07-31, 11:03	#1 (permalink)
Anonymous Guest Posts: n/a	MediaPortal manual Very cool. May I suggest : - using XML (DocBook ?) or HTML as the source format - issuing this documentation under the GNU FDL license Thanks to the authors!

Thread Tools
Show Printable Version Email this Page
Display Modes
Linear Mode Switch to Hybrid Mode Switch to Threaded Mode

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
System requirements for HDTV with MediaPortal	Tech Geek	Hardware Selection Help	62	2007-08-08 07:20
MediaPortal GET YOU GOING GUIDE	aal	Tips and Tricks	19	2007-06-22 18:39
A perfect HTPC with MP & PVR Scheduler & faster XP	STSC	Tips and Tricks	16	2007-01-30 22:40
PVR Scheduler: cant make it work	ethanx	Codecs, External Players	1	2006-03-19 23:42
Compile problems	Anonymous	General Development (no feature request here!)	1	2004-04-28 21:49

2004-08-05, 17:15	#2 (permalink)
Anonymous Guest Posts: n/a	Hi Epoch, At the present time the documentation is being distributed in PDF format, for regional reasons. It was created with A4 LTR size, then converted to US LTR, and then formatting got unwieldy. So for now, it is being created in OpenOffice [.swx], converted to PDF for present distribution, then later an A4 Ltr will probably be produced. Other formats are fine, but too much maintenance at the moment. Once MP is finalized, and a finished document is produced, then we may consider alternative formats. I guess we just have too much time on our hands! :wink:

2004-08-05, 20:44	#3 (permalink)
Mr.Mitchell Retired Team Member Join Date: May 2004 Location: the Netherlands Posts: 227 Thanks: 1 Thanked 0 Times in 0 Posts	Actually XML/Docbook sounds like a good idea. That way more people can work on the manual at the same time (if it is in CVS) and if I am not mistaken you can generate documentation in all kinds of formats like PDF for easy printing or HTML to put the documentation online.

2004-08-06, 19:10	#4 (permalink)
Anonymous Guest Posts: n/a	Thanks for your interest. Let me rephrase to make my intentions clearer : a) 1st thing 1st: I think there is need for a licensing scheme that goes well w/ GPL to allow translators (and plugin authors, and....) contributing to the documentation. b) Opening the doc requires : - an open format, like HTML or XML to warrant easy access - a strong structure to make a homogeneous final document from the input of a variety of contributors c) The final output should be generated from the structured data, hopefully using proven tools. I personnaly like Pdf. I am sure others will want HTML, or RTF... Hence my Docbook proposal : an XML scheme backed with good document generators (don't know the status on windows). I could try looking into this if you'd like. I would need the OO source to play with it. Is it in the CVS tree ? Or could you post it on the website ? Thx in advance.