|
|
Download
| User
Forum |
Gallery Contact Us |
| Home > Collaboration > Working Groups > Documentation |
Documentation Working GroupResponsibilitiesThe Geant4 documentation working group is responsible for maintaining and improving the following user documents and example codes:
Working Group Members and Their Responsibilities
Working Plan - 2010Make available updated users' documents in accordance with major/minor Geant4 code releases. Also irregular revisions of the documents are expected. Working Plan - 2009Make available updated users' documents in accordance with major/minor Geant4 code releases. Also irregular revisions of the documents are expected. Working Plan - 2008The transition from HTML to DocBook based documentation was successfully completed in the last year. The new scheme (i.e. the DocBook format) is already stable and the last three releases (V8.3, V9.0, V9.1) are based on it. In this year, because of the stability of the newly developed documentation scheme, we don't have a challenging plan as we had in the last year. We are planning to release all users' documents in accordance with Geant4 code releases. Working Plan - 2007DocBook ProjectThe aim of the DocBook project is to convert the following user documents into the DocBook format:
The global time schedule for this project is as follows:
|
In the Lisbon Geant4 International Workshop (2006), we agreed to move all Geant4 users' manuals except 'Physics Reference Manual' from HTML to DocBook. In this section we provide information about how to move to DocBook.
The following note gives you a brief introduction to DocBook. It provides an essential minimum of knowledge required when to update/revise a G4 manual.
In the Geant4 CVS repository, we have created a completely new tree for the DocBook version of Geant4 user manuals.
- New tree: documents/UserDoc/DocBookUsersGuides
documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper
documents/UserDoc/DocBookUsersGuides/ForToolkitDeveloper
documents/UserDoc/DocBookUsersGuides/InstallationGuide
documents/UserDoc/DocBookUsersGuides/IntroductionToGeant4
documents/UserDoc/DocBookUsersGuides/PhysicsReferenceManual
[Note] The following is the old tree of UsersGuides
- Old tree: documents/UserDoc/UsersGuides <-- You cannot commit to any document under this tree!
documents/UserDoc/UsersGuides/ForApplicationDeveloper
documents/UserDoc/UsersGuides/ForToolkitDeveloper
documents/UserDoc/UsersGuides/InstallationGuide
documents/UserDoc/UsersGuides/PhysicsReferenceManual
Please take note the following points when you update a Geant4 user manual after the beta release of DocBook to the G4 collaborators (the release date: April 23, 2007).
[Important Note]
% cvs co -d DocBookUsersGuides documents/UserDoc/DocBookUsersGuidesThis will create the directory 'DocBookUsersGuides' under your checkout area. The directory has the whole tree of the G4 user guides in DocBook - see the next bullet for 'Physics Reference Manual'. After April 23, 2007 any update to a G4 user manual have to be done to the files under the new tree.
You can find below the G4 user manuals (in HTML and pdf) generated from the beta release of the DocBook version.
The fist public release of the DocBook generated G4 user manuals is scheduled at the next major release of Geant4 toolkit.
Last updated: 11 Feb 2010