|
Developers' and users' guides org.cmscc.qmcpack.doc is developed as an eclipse plug-in for QMCPACK help page. If all goes well, a help document with - build instructions
- doxygen code documentation
- other materials on wiki
can be downloaded as an eclipse plug-in. Licensed under UIUC/NCSA open-source license See more on UIUC/NCSA license Instructions for viewing help page in eclipsesvn co http://qmcpack-doc.googlecode.com/svn/trunk/org.cmscc.qmcpack.doc change to org.cmscc.qmcpack.doc/html and unzip doxy.zip start eclipse go to Help -> Help Contents and a browser will load the help documents The documentation generated by doxygen is in doxy.zip (> 100 mb) file and will be updated whenever important changes in the code are made. Instructions for writing document- checkout org.cmscc.qmcpack.doc in your eclipse workspace directory by
svn co https://qmcpack-doc.googlecode.com/svn/trunk/org.cmscc.qmcpack.doc change to org.cmscc.qmcpack.doc/html and unzip doxy.zip start eclipse (optional) - add a project (or refresh the content): you may already have all you need.
add contents as html files in html directory. - It is not necessary to use eclipse, unless you are interested in developing an eclipse plug-in.
- Consider the directory structure and place the files in an appropriate directory. Do not worry about the TOC. JK will take care of how the document is organized.
- Write clean, validated html (matching tags). Copy one of the existing files and modify the body.
- Inspect a html file with xmllint
- css files will be customized for the look
add contents as latex file in latex directory - ug-toc.xml defines the structure of QMCPACK userguide
- docs/usrdoc directory of the code repository is imported to the documentation project on 2010-10-10
- how-to is coming soon.
Eclipse ScreenshotThe navigation panel (left) is alphabetically sorted. Look for "QMCPACK ...". Screenshot of the front page of QMCPACK document in eclipse 
|
