#2194: type out formulas in TeX format
---------------------------+------------------------------------------------
Reporter: hamish | Owner: grass-dev@…
Type: task | Status: new
Priority: trivial | Milestone: 7.0.0
Component: Docs | Version: svn-trunk
Keywords: TeX, formulae | Platform: All
Cpu: All |
---------------------------+------------------------------------------------
Hi, a rainy day project for someone:
many modules' help pages include images used in them, and just about all
of those use a different font, style, etc.
it would be nice wherever these appeared there was also a .tex file in the
module dir which the build process could use to auto-generate the embedded
png image, so that all math rendering was consistent in the docs.
#2194: type out formulas in TeX format
---------------------------+------------------------------------------------
Reporter: hamish | Owner: grass-dev@…
Type: task | Status: new
Priority: trivial | Milestone: 7.0.0
Component: Docs | Version: svn-trunk
Keywords: TeX, formulae | Platform: All
Cpu: All |
---------------------------+------------------------------------------------
Description changed by hamish:
Old description:
Hi, a rainy day project for someone:
many modules' help pages include images used in them, and just about all
of those use a different font, style, etc.
it would be nice wherever these appeared there was also a .tex file in
the module dir which the build process could use to auto-generate the
embedded png image, so that all math rendering was consistent in the
docs.
thanks,
Hamish
New description:
Hi, a rainy day project for someone:
many modules' help pages include images showing the formulas used in them,
and just about all of those use a different font, style, etc.
it would be nice wherever these appeared there was also a .tex file in the
module dir which the build process could use to auto-generate the embedded
png image, so that all math rendering was consistent in the docs.
Yes, formulas seems to be very important for scientific GIS.
What I'm used to see in GRASS manual are not images but just `<div
class="code"><pre>` blocks with programming-like syntax (preformatted
plain text). I though that this is the preferred way. But sometimes it
syntax is very different, especially for fractions.
The ways how to support nice formulas are something like:
* existing documentation tool such as [http://sphinx-doc.org/ Sphinx],
[http://doxygen.org/ Doxygen], or perhaps even low level tools such as
[http://docutils.sourceforge.net/ Docutils] or
[http://docutils.sourceforge.net/ pandoc] would be sufficient (i.e. not
use our custom system and use some tool which already solved this problem)
* some HTML way such as [http://en.wikipedia.org/wiki/MathML MathML] or
[http://www.mathjax.org/ MathJax]
* create some custom tool which would integrate to the current manual
system (this would bring compile-time dependency, probably LaTeX)
* go the same way as for images of results (maps) where HTML contains
steps how to create the image but also the image is in SVN repository (you
need the tools only if you are updating the formula)
* use the preformatted plain text option (it wouldn't be nice but unified
and perhaps easier to use in `r.mapcalc` expression or in code)