how_to_edit_this_wiki
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
how_to_edit_this_wiki [2021/05/06 11:38] – [Special Requirements] gocht | how_to_edit_this_wiki [2022/11/07 10:23] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 22: | Line 22: | ||
[[playground: | [[playground: | ||
+ | |||
+ | |||
+ | =====Convert Word documents to the dokuwiki format===== | ||
+ | |||
+ | Technical documents on new model developments are often prepared in Word format. To disseminate their information content, those documents can be converted to the dokuwiki format and be included into the CAPRI wiki. This section provides a few tips on how to do the conversion of Word documents. | ||
+ | |||
+ | |||
+ | * The Pandoc software provides an easy-to-use framework for document conversion. [[https:// | ||
+ | * For converting mathematical formulas, you will need Latex. Miktex is the most common Latex package for Windows [[https:// | ||
+ | * Pandoc can be used from the command line, or by optionally including the commands in a batch file. A simple example for converting the Word document ' | ||
+ | < | ||
+ | * Pictures in the Word document can not be converted automatically with pandoc. Those must be included by first uploading them using the 'Media Manager' | ||
+ | < | ||
+ | * The hierarchy of the section headers (levels) might need to be revised after the conversion, depending on where the converted document will be inserted in the CAPRI wiki | ||
+ | * Be careful with spacing in latex math mode. Sometimes the Word formulas include white spaces that are converted to strange symbols in the dokuwiki version. More about the white spaces in math mode [[http:// | ||
+ | |||
+ | |||
+ | |||
+ | ===== Equation editing in the wiki ===== | ||
+ | |||
+ | |||
+ | In the doku wiki we are using the a plugin called MathJax (https:// | ||
+ | |||
+ | <code html> | ||
+ | \begin{equation} | ||
+ | \text{min} \quad hp=1000 \sum_{1< | ||
+ | \end{equation} | ||
+ | |||
+ | \begin{equation} | ||
+ | \left( | ||
+ | \begin{array}{c} | ||
+ | n \\ | ||
+ | r | ||
+ | \end{array} | ||
+ | \right) = \frac{n!}{r!(n-r)!} | ||
+ | \end{equation} | ||
+ | |||
+ | </ | ||
+ | |||
+ | which is rendered as: | ||
+ | |||
+ | \begin{equation} | ||
+ | \text{min} \quad hp=1000 \sum_{1< | ||
+ | \end{equation} | ||
+ | |||
+ | |||
+ | \begin{equation} | ||
+ | \left( | ||
+ | \begin{array}{c} | ||
+ | n \\ | ||
+ | r | ||
+ | \end{array} | ||
+ | \right) = \frac{n!}{r!(n-r)!} | ||
+ | \end{equation} | ||
+ | |||
+ | |||
+ | How to write a formular see: https:// | ||
+ | |||
+ | ====== CAPRI documentation as PDF ====== | ||
+ | |||
+ | Necessary Programs: | ||
+ | - Python: https:// | ||
+ | - Any LateXenvironment capable of LuaLaTex e.g. https:// | ||
+ | - Pyton Script: https:// | ||
+ | |||
+ | Executing the Pythonscript creates the folder " | ||
+ | The tex.files get modified to allow for LuaLaTeX PDFexport, to do so open the " | ||
+ | and choose LuaLaTeX then start PDF generation. | ||
+ | Table of content and intradocument references will display correctly after second run of LuaLaTeX. | ||
+ | This creates " | ||
+ | |||
+ | ### Known Issues (work in progress)### | ||
+ | 1. Longtables can be wider then the page (easiest to adapt manually) | ||
+ | 3. Cells with rowbreak are not completly outlined (maybe fix manually, will try to catch in the code) | ||
+ | 4. figures only seperated by empty line (in the Wiki) appear beside each other not under, results in wrongly scaled figures. | ||
+ | |||
+ | |||
+ | ====== List of CAPRI manuals in pdf format ====== | ||
+ | |||
+ | [[https:// | ||
+ | |||
+ | |||
+ | https:// | ||
+ | |||
+ |
how_to_edit_this_wiki.1620301103.txt.gz · Last modified: 2022/11/07 10:23 (external edit)