type out formulas in TeX format

landam commented 5 years ago

Reported by hamish on 9 Feb 2014 07:25 UTC 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

GRASS GIS version and provenance

svn-trunk

Migrated-From: https://trac.osgeo.org/grass/ticket/2194

landam commented 5 years ago

Modified by hamish on 9 Feb 2014 07:26 UTC

landam commented 5 years ago

Comment by wenzeslaus on 9 Feb 2014 14:06 UTC 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)

landam commented 5 years ago

Modified by @landam on 12 May 2016 06:44 UTC

landam commented 5 years ago

Modified by @landam on 23 Aug 2016 12:52 UTC

landam commented 5 years ago

Comment by @landam on 27 Aug 2016 13:42 UTC Milestone renamed

landam commented 5 years ago

Comment by neteler on 26 Jan 2018 11:40 UTC Ticket retargeted after milestone closed

landam commented 5 years ago

Modified by neteler on 12 Jun 2018 20:48 UTC

landam commented 5 years ago

Modified by @landam on 25 Sep 2018 18:22 UTC

landam / grass-gis-git-migration-test

type out formulas in TeX format #104

GRASS GIS version and provenance