User Manuals: Difference between revisions

From OpenPetra Wiki
Jump to navigation Jump to search
Line 4: Line 4:
The plan is to write the documentation here in the wiki, and then to automatically export it into PDF format and into Windows Help format, and possibly other formats as well.
The plan is to write the documentation here in the wiki, and then to automatically export it into PDF format and into Windows Help format, and possibly other formats as well.


TODO: instructions about how to organise chapters, topics, screenshots etc
TODO: instructions about how to organise chapters, topics, screenshots etc.


UPDATE: have a look at http://en.flossmanuals.net. They use TWiki to create free manuals, and use http://www.xhtml2pdf.com/ to create PDF and HTML books from it. They have ways to translate books as well. The question is whether there is a way to create Windows Help files as well?
UPDATE: have a look at http://en.flossmanuals.net. They use TWiki to create free manuals, and use http://www.xhtml2pdf.com/ to create PDF and HTML books from it. They have ways to translate books as well. The question is whether there is a way to create Windows Help files as well?
UPDATE: see the history of Windows Help files:
* http://en.wikipedia.org/wiki/Microsoft_WinHelp (.hlp)
* http://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help (.chm)
** compiles HTML files into a chm file
* http://en.wikipedia.org/wiki/Microsoft_Help_2: (.hxs), used with Visual Studio 2002/2003/2005/2008 and Office 2007
* http://en.wikipedia.org/wiki/Microsoft_Help_System: (.mshc), used with Visual Studio 2010
** http://www.helpware.net/mshelp3/intro.htm
** plain html files, index will be generated by the viewer. TOC and index are defined by using meta tags.
* see also http://en.wikipedia.org/wiki/Microsoft_Assistance_Markup_Language


== Installation ==
== Installation ==

Revision as of 15:23, 18 November 2010

User Manuals

At this point in time, there is no proper documentation for users yet. You might want to have a look at the old Petra 2.2 User Guides.

The plan is to write the documentation here in the wiki, and then to automatically export it into PDF format and into Windows Help format, and possibly other formats as well.

TODO: instructions about how to organise chapters, topics, screenshots etc.

UPDATE: have a look at http://en.flossmanuals.net. They use TWiki to create free manuals, and use http://www.xhtml2pdf.com/ to create PDF and HTML books from it. They have ways to translate books as well. The question is whether there is a way to create Windows Help files as well?

Installation

Please see Installation Manuals.

General introduction

Partner Module

Finance Module

Personnel Module

Conference Module

more TODO

Tutorials