I have close to 3 decades technical writing experience. Naturally, I have an interest in any documentation packaged with Trinity. :)
The Help files need serious attention. In KDE 3.5.10 many Help files are out-of-date. Eventually we have to update those Help files.
I don't know how the original Help files were maintained or created. I need help and direction with that.
I want to see an overall user guide to Trinity. The guide would be available in two forms: HTML and PDF. The HTML version would be a desktop shortcut available to all users who first install Trinity and should be a menu option for those who delete the shortcut.
I am willing to lead this part of the project. I face an immediate challenge: my background is overwhelmingly with paper products and not electronic. I need help and advice with the tools I need to learn to produce two different outputs (HTML and PDF). OpenOffice Writer (now LibreOffice) might be a choice, but I suspect the HTML output will leave much to be desired. Some sort of structured authoring front-end would makes sense (DocBook?), but that means a lot of sweat equity to massage the back end formatting. The system used to produce the original Help files might be a solution.
I am open to ideas and discussion.
Darrell
On Wed, Mar 9, 2011 at 13:42, Darrell Anderson humanreadable@yahoo.com wrote:
I have close to 3 decades technical writing experience. Naturally, I have an interest in any documentation packaged with Trinity. :)
*sparkling eyes with happy face*
The Help files need serious attention. In KDE 3.5.10 many Help files are out-of-date. Eventually we have to update those Help files.
I don't know how the original Help files were maintained or created. I need help and direction with that.
Probably with docbook.
I want to see an overall user guide to Trinity. The guide would be available in two forms: HTML and PDF. The HTML version would be a desktop shortcut available to all users who first install Trinity and should be a menu option for those who delete the shortcut.
I am willing to lead this part of the project. I face an immediate challenge: my background is overwhelmingly with paper products and not electronic. I need help and advice with the tools I need to learn to produce two different outputs (HTML and PDF). OpenOffice Writer (now LibreOffice) might be a choice, but I suspect the HTML output will leave much to be desired. Some sort of structured authoring front-end would makes sense (DocBook?), but that means a lot of sweat equity to massage the back end formatting. The system used to produce the original Help files might be a solution.
+10000000 for docbook. lol.
On Wednesday 09 March 2011 21:42:14 Darrell Anderson wrote:
I want to see an overall user guide to Trinity. The guide would be available in two forms: HTML and PDF. The HTML version would be a desktop shortcut available to all users who first install Trinity and should be a menu option for those who delete the shortcut.
This guide by SUSE may be useful to you:
https://build.opensuse.org/package/files?package=opensuse-kde3user_en&pr...
1. Does anybody know where we can grab the old KDE3 web site? Hopefully all of that info is archived somewhere and can be migrated to the Trinity web site?
2. The current KDE web site has a nice intro to the desktop environment (http://userbase.kde.org/). All content is licensed under Creative Commons License SA 3.0 and the GNU Free Documentation License 1.2. We could save time my imitating most of the overall structure.
3. I have copies of two KDE3 user guides in PDF. One is from OpenSuse 11.0 and the other from the Asia-Pacific Development Information Programme. Lots of good info in both. There likely are some other guides that we can use. Please let me know.
4. I found the following: http://userbase.kde.org/How_To_Convert_a_UserBase_Manual_to_Docbook. Currently this stuff makes my eyes water --- all Greek to me at the moment. :)
Darrell
--- On Wed, 3/9/11, Darrell Anderson humanreadable@yahoo.com wrote:
From: Darrell Anderson humanreadable@yahoo.com Subject: [trinity-devel] Trinity End-User Documentation To: trinity-devel@lists.pearsoncomputing.net Date: Wednesday, March 9, 2011, 12:42 PM I have close to 3 decades technical writing experience. Naturally, I have an interest in any documentation packaged with Trinity. :)
The Help files need serious attention. In KDE 3.5.10 many Help files are out-of-date. Eventually we have to update those Help files.
I don't know how the original Help files were maintained or created. I need help and direction with that.
I want to see an overall user guide to Trinity. The guide would be available in two forms: HTML and PDF. The HTML version would be a desktop shortcut available to all users who first install Trinity and should be a menu option for those who delete the shortcut.
I am willing to lead this part of the project. I face an immediate challenge: my background is overwhelmingly with paper products and not electronic. I need help and advice with the tools I need to learn to produce two different outputs (HTML and PDF). OpenOffice Writer (now LibreOffice) might be a choice, but I suspect the HTML output will leave much to be desired. Some sort of structured authoring front-end would makes sense (DocBook?), but that means a lot of sweat equity to massage the back end formatting. The system used to produce the original Help files might be a solution.
I am open to ideas and discussion.
Darrell
To unsubscribe, e-mail: trinity-devel-unsubscribe@lists.pearsoncomputing.net For additional commands, e-mail: trinity-devel-help@lists.pearsoncomputing.net Read list messsages on the Web archive: http://trinity-devel.pearsoncomputing.net/ Please remember not to top-post: http://trinity.pearsoncomputing.net/mailing_lists/#top-posting
On Wed, Mar 9, 2011 at 3:24 PM, Darrell Anderson humanreadable@yahoo.com wrote:
- Does anybody know where we can grab the old KDE3 web site? Hopefully all of that info is archived somewhere and can be migrated to the Trinity web site?
<snip>
I'm sure we could find it at http://www.archive.org/ if we know when the KDE3 site went bye-bye, we just look it up on the archive immediately before that. They also still seem to have some stuff on KDE3 posted, just a bit hidden.
I can help writing the user docs once I get my build system (laptop) fixed and have TDE built. I can even do a basic HTML mockup via WYSIWYG and basic HTML. I'm no expert with HTML, but from what I've seen, most guides have a table of contents that link to another page about that setion, with a forward and back link (and a link back to the table of contents) at the bottom. I've never really liked this format, but with some feedback I'm sure I could terraform it into something a bit more usable.
On Wed, 9 Mar 2011 10:42:14 -0800 (PST) Darrell Anderson wrote:
I have close to 3 decades technical writing experience. Naturally, I have an interest in any documentation packaged with Trinity. :)
Take a look at Calenco (http://calenco.com) specificly designed for this type of documentation. Unfortunately the webpage is in French as present.
John