About OGS5 Keyword documentation
Notes on Usage
Visibility, Permissions
The documentation is extensively cross-linked. All the links between documentation wiki pages should work for everybody.
There are also links pointing to benchmarks and some pointing to source code. The former should also work for everybody, for the latter, however, you have to be logged in.
When you are logged in, you can also search the documentation. For that, just use the search box in the top-right corner of the webpage. In order to find only pages from the docs you might want to always add /doc to your search terms, e.g.: Search for $PCS_TYPE.
Notes on Contribution
You are always welcome to improve and extend out keyword documentation.
In order to edit our pages, you have to log in. If that is impossible for you, please write an email.
There are only a few points to keep in mind when contributing:
- Wiki pages have a version history. So don't fear you could destroy anything. Even in the worst case, it can be restored.
- There are two documentation trees: public/doc-auto and public/doc. The former is the one you usually see. It is automatically created and recreated by some scripts. Don't edit its pages since they will be overwritten in regular intervals! The latter, public/doc, is the place for handwritten documentation.
- In order to find the right page for your handwritten documentation, just browse public/doc-auto as you normally do, then follow the link (not the button!) at the bottom of the page. It will take you to the corresponding page from public/doc. You can then edit this page.
- If you want to make sure, you edit the right page, the following applies:
For example you want to edit the documentation of the keyword $LINEAR_SOLVER from the input file num.
The URL if the automatically generated documentation is
and the URL of the page you should edit ishttps://svn.ufz.de/ogs/wiki/public/doc-auto/by_ext/num/S_linear_solver
Note the change doc-auto → doc.https://svn.ufz.de/ogs/wiki/public/doc/by_ext/num/S_linear_solver
