User Manuals: Difference between revisions

From OpenPetra Wiki
Jump to navigation Jump to search
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== User Manuals ==
== Overview ==
At this point in time, there is no proper documentation for users yet. You might want to have a look at the old [http://www.ict-software.org/petra/index.php?page=PetraUserGuides Petra 2.2 User Guides].
''At this point in time, there are no comprehensive User Guides for OpenPetra users available.''


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.
===Current Options===
* A [[Basic Tutorial]] on OpenPetra is available. This is a guide to some of the basic functionality that is available in OpenPetra.
* A first start has been made at https://docs.openpetra.org/ and https://handbuch.openpetra.de/


TODO: instructions about how to organise chapters, topics, screenshots etc
==Goals of OpenPetra User Guides==
===Content===
* Should provide thorough instructions and answers on how to use OpenPetra effectively.


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?
===Portable===
* User Guides should be viewable on any operating system. This goal could be reached by providing the User Guides in PDF format.


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 ==
Please see [[Installation Manuals]].


== General introduction ==
===Authoring of User Guides===
====Using Sphinx====
The plan is to write the content of the User Guides with Sphinx, store them in Github, and publish them at https://docs.openpetra.org/. Sphinx also allows to produce PDF files.


== Partner Module ==
See https://docs.openpetra.org/contributions/index.html for more details!


== Finance Module ==
Sphinx projects can be published at https://readthedocs.org/
 
* [[HowTo: Initial setup of a ledger]]
 
== Personnel Module ==
 
== Conference Module ==
 
== more TODO ==

Latest revision as of 06:29, 10 September 2022

Overview

At this point in time, there are no comprehensive User Guides for OpenPetra users available.

Current Options

Goals of OpenPetra User Guides

Content

  • Should provide thorough instructions and answers on how to use OpenPetra effectively.

Portable

  • User Guides should be viewable on any operating system. This goal could be reached by providing the User Guides in PDF format.


Authoring of User Guides

Using Sphinx

The plan is to write the content of the User Guides with Sphinx, store them in Github, and publish them at https://docs.openpetra.org/. Sphinx also allows to produce PDF files.

See https://docs.openpetra.org/contributions/index.html for more details!

Sphinx projects can be published at https://readthedocs.org/

Retrieved from ‘https://wiki.openpetra.org/index.php?title=User_Manuals&oldid=4923’