Opened 10 years ago

Last modified 4 years ago

#2194 new task

type out formulas in TeX format

Reported by: hamish Owned by: grass-dev@…
Priority: trivial Milestone: 7.8.3
Component: Docs Version: svn-trunk
Keywords: TeX, formulae, formulas, formulæ Cc:
CPU: All Platform: All

Description (last modified by hamish)

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.

thanks, Hamish

Change History (12)

comment:1 by hamish, 10 years ago

Description: modified (diff)

comment:2 by wenzeslaus, 10 years ago

Keywords: formulas formulæ added

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 Sphinx, Doxygen, or perhaps even low level tools such as Docutils or 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 MathML or 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)

comment:3 by martinl, 8 years ago

Milestone: 7.0.07.0.5

comment:4 by martinl, 8 years ago

Milestone: 7.0.57.3.0

comment:5 by martinl, 8 years ago

Milestone: 7.3.07.4.0

Milestone renamed

comment:6 by neteler, 6 years ago

Milestone: 7.4.07.4.1

Ticket retargeted after milestone closed

comment:7 by neteler, 6 years ago

Milestone: 7.4.17.4.2

comment:8 by martinl, 6 years ago

Milestone: 7.4.27.8.0

comment:9 by neteler, 5 years ago

Milestone: 7.8.07.8.1

Ticket retargeted after milestone closed

comment:10 by neteler, 4 years ago

Milestone: 7.8.17.8.2

Ticket retargeted after milestone closed

comment:11 by neteler, 4 years ago

Milestone: 7.8.2

Ticket retargeted after milestone closed

comment:12 by neteler, 4 years ago

Milestone: 7.8.3
Note: See TracTickets for help on using tickets.