CERN Accelerating science

Workplan 2013

2013 Work Plan

The 2013 Work Plan is divided into four categories, with responsible members and approximate deadlines (end of calendar-year quarters) listed.

  1. Membership and Organization
  2. Documentation Structure
  3. Documentation Content
  4. Web Site Content

Last updated: 5 February 2013 (intro)


Membership Organization

 

Task Responsible Due
Solicit new members with active interest in documentation and outreach.
Pere Mato? Ben Morgan?
All 1Q
Identify developers responsible for each chapter/section of App.Dev., Toolkit, and FAQ. Need not be WG members, but active contact. Is this tests/responsibles? WG Coordinators
geant4-cat-coordinators{AT}cern.ch
Done
Produce a documentation Style Guide (or point to example chapter properly formatted) to support members and developers in contributing to the XML documentation in a consistent format. See also Documentation Content. Kelsey, Ivana 2Q

Documentation Structure

 

Task Responsible Due
Remove FAQ section from App.Dev., move contents to separate FAQ Book. Integrate contents of old FAQ Web page (www/support/faq.shtml), and replace the latter with a link to the new FAQ book. Kelsey 3Q
Remove layer of SVN repository (move DocBookUsersGuides subdirectories directly under UserDoc). Kelsey 1Q
Identify separable parts of Physics Manual, provide top-level XML to generate multiple "books" for each chapter, in addition to the single document. Can EM be split into two or more parts?   3Q
Identify separable parts of App.Dev., provide top-level XML to generate multiple "books" as above. Can Tracking and Physics be split into two or more parts?   3Q
Address latex2html issues to support generating HTML version of Physics. What about Wiki-style math markup? Kelsey 2Q
Modify the local HTML specialization (XML style sheet) to generate chapter-by-chapter tables of contents at the top of each chapter page. Kelsey 3Q
Encourage major developent areas to write publication papers as well as updating Toolkit Book documentation. J. Allison 3Q

Documentation Content

Task Responsible Due
Coordinate with MT developers (in Run/Event/Detector WG) to ensure that
  1. Toolkit Book fully documents changes required, and requirements for new classes, for multi-thread functionality.
  2. App.Dev. included detailed support for users in creating and running multithreaded applications (not just "point to examples").
Kelsey, Dotti 2Q
Provide documentation for QMD in Physics Reference Manual: MC 2010 slides, proceedings T. Koi 3Q
Expand the Neutron HP section of Physics to include charged particle interactions P. Arce 3Q
Updated documentation for FTF in Physics V. Uzhinsky 2Q
If ready to be deployed, documentation for phonons and lattice in Physics and App.Dev. books D. Brandt 3Q
Toolkit Guide is incomplete, many of the UML diagrams are out of date. Should it be updated, replaced, or abandoned? Do current developers still make use of it? D. Wright 3Q
Review documentation in detail to identify typos, missing text, etc. All 3Q
Reduce use of bulleted lists for sectional or content. All 3Q
Replace bulleted lists with mutually consistent "definitional lists" (<variablelist>) or tables for documenting classes, functions, and parameters. All 3Q
Unify markup of source code entities (classes, functions, parameters): bold, monospace, whatever, but should be the same all the way through. Maybe define a content-oriented markup tag (a la "<Code>" in HTML) to be used throughout? All 3Q
Should we enhance the <programlisting> output to highlight syntax? XSLTHL Project, examples Kelsey 3Q

Web Site Content

Task Responsible Due
Merge Web-based FAQ content into FAQ Book (see above) Kelsey, Folger 2Q
Integrate Web-based style sheet usage and SHTML into DocBook HTML, to provide consistent "look and feel" for GEANT4 documentation. Kelsey, Wright 3Q
Expand Web pages of publications, validation results, and external citations, per suggestion from 2012 external review. Kelsey, Wright 2Q