diff options
| author | Dimitri van Heesch <doxygen@gmail.com> | 2019-12-25 09:04:23 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-25 09:04:23 (GMT) |
| commit | ff3fdb3ac14a1f90334ca6c40eac46c772b5af63 (patch) | |
| tree | 9fc8728c52e91e673137b631ef2f8bd613dfe164 /doc | |
| parent | fabc8146c8bdbdedcb2d2d8630a5eb60de3f5dc0 (diff) | |
| parent | fd3b60caa8bb99bec81b74d74f394c6043091c76 (diff) | |
| download | Doxygen-ff3fdb3ac14a1f90334ca6c40eac46c772b5af63.zip Doxygen-ff3fdb3ac14a1f90334ca6c40eac46c772b5af63.tar.gz Doxygen-ff3fdb3ac14a1f90334ca6c40eac46c772b5af63.tar.bz2 | |
Merge pull request #7230 from albert-github/feature/bug_formula_macrofile
Create possibility to define LaTeX commands for formulas
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/formulas.doc | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/formulas.doc b/doc/formulas.doc index 520f089..88a8725 100644 --- a/doc/formulas.doc +++ b/doc/formulas.doc @@ -100,9 +100,27 @@ the section should contain valid command for the specific environment. \warning Currently, doxygen is not very fault tolerant in recovering from typos in formulas. It may be necessary to remove the -files <code>formula.repository</code> that are written to the html and rtf directories to +files <code>formula.repository</code> that are written to the html, rtf etc. directories to get rid of an incorrect formula as well as the <code>form_*</code> files. +To have the possibility to define your own \LaTeX commands, for e.g. formula building blocks +or consistent writing of certain words, the configuration option \ref cfg_formula_macrofile "FORMULA_MACROFILE" +can be used. to supply a file with \LaTeX commands. +This file can contain \LaTeX `\newcommand` and \`renewcommand` commands and they are included +formulas (image version and MathJax version) as well as in the generated \LaTeX output (for PDF generation).<br> +The `\newcommand` (and `\renewcommand`) are restricted to a version without optional +parameters so only the following types are supported: +``` +\newcommand{\cmd}{replacement} + and +\newcommand{\cmd}[nr]{replacement} +``` +e.g. +``` +\newcommand{\E}{\mathrm{E}} +\newcommand{\ccSum}[3]{\sum_{#1}^{#2}{#3}} +``` + \htmlonly Go to the <a href="tables.html">next</a> section or return to the <a href="index.html">index</a>. |