User Tools

Site Tools


howto:generate_manual

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
howto:generate_manual [2014/08/28 16:19] oschuetthowto:generate_manual [2024/02/24 10:11] (current) oschuett
Line 1: Line 1:
-====== Howto generate the Input Reference Manual ====== +This page has been moved tohttps://github.com/cp2k/cp2k/blob/master/docs/README.md
-=== Step 1Download an XSTL processor=== +
-We use the //Saxon-HE (home edition)// version 9 . It can be downloaded from [[http://saxon.sourceforge.net/]] +
- +
- +
-=== Step 2: Compile CP2K === +
-This is explained in detail [[howto:compile|elsewhere]]. +
- +
-=== Step 3: Generate an intermediated XML file === +
-<code> +
-cp2k.popt --xml  +
-</code> +
-This generates the file ''cp2k_input.xml'' which contains the entire input description. +
- +
-=== Step 4: Goto cp2k/tools/manual === +
-<code> +
-$ cd cp2k/tools/manual +
-$ java -jar saxon9he.jar  -o:index.html cp2k_input.xml cp2k_input.xslcp2k.popt +
-</code> +
- +
-This will create the actual HTML files, which we make available [[http://manual.cp2k.org/]] +
howto/generate_manual.1409242775.txt.gz · Last modified: 2020/08/21 10:15 (external edit)