- This repository includes the source files for building part of the Elmer documentation.
- Currently ElmerGUI Manual and Elmer Tutorials are provided. The other parts of the documentation are not yet in open repository.
- The documentation here is licensed under Creative Commons Attribution-NonCommercial.
- latex-elmer-getstart - Get Started with Elmer document
- latex-elmergui - latex input files to build ElmerGUI manual
- latex-tex-start - getting started with TeXworks and editing manuals
- latex-tex-template - a template in TeXworks for building new tutorials
- latex-tutorials-CL - latex input files to build tutorials manual without graphical user interface (command-line usage, files explained)
- latex-tutorials-GUI - latex input files to build tutorials manual where ElmerGUI is used
- tutorials-CL-files - sample input output files related to the tutorials without using the graphical user interface
- tutorials-GUI-files - sample input output files related to using ElmerGUI for the tutorials
- To build the documentation requires LaTex being installed.
- To create the documentation under Linux you can open a terminal window in the 'elmerfem-manuals' directory and type "source makedoc.sh".
- If you get an error like 'float.sty not found', then you may need to install the 'extra' package: 'sudo apt-get install texlive-latex-extra'.
- To build with LaTeX in Windows, install 'MikTex'.
- Msys2 has a bash shell that can run the 'source makedoc.sh' script.
- Installing Git usually also installs 'Git Bash' as a right click context menu selection and Git Bash can run the 'source makedoc' script.
- TeXworks is a LaTex editor that can be used to edit a single manual.
- TeXworks can be used in Linux and in Windows. For Windows, installing 'MikTex' will also TeXworks.
- Select 'pdfLaTeX+MakeIndex+BibTeX' in order to build a manual.
- It is suggested to use the TeXworks dictionary 'English - United Kingdom (en-GB) for spelling checks.