cwb_mkhtml


Usage

This command is used to convert a texi or a c-code file to html.

Syntax

  • cwb_mkhtml path/file.texi options header/wheader/nheader/pdf(optional)

  • path/file.texi : this is the full path of texi file

    • path : the path of a directory (if it contains png file it creates html with the list of plots)

    • options : the path options

      • ‘–multi true/false(default)’ : true/false = plots are displayed in 2/1 columns

      • ‘–title TITLE’ : is the TITLE displayed on the top of plot list

      • ‘–subtitle SUBTITLE’ : is the SUBTITLE displayed below the TITLE

      • Example:

        cwb_mkhtml PATH ‘–multi true –title TITLE –subtitle SUB#TITLE’

        Note

        The spaces in the title/subtitle must be declared with # : Ex: ‘–title SUB#TITLE’

    • file.texi : the texi file name must have the .texi extension

  • wheader/nheader/pdf : this option add cwb header to the html, it is optional

  • wheader is equivalent to header : use wider header
  • nheader : use narrow header
  • pdf : create pdf
  • cwb_mkhtml path/file.ext [allowed extensions: C/cc/hh/c/h]
  • path/file.ext : this is the full path of c-code file, the allowed extensions are [C/cc/hh/c/h]. If only path is declared then an html file with the list of png plots contained in the path dir is created

MathJax

It is possible to include mathematical formulae using MathJax
The MathJax project is an open source JavaScript platform for display of mathematics in html pages
The formulae can be defined with LaTeX notation.
This is an example that shows how to include a formula in a html page.


Example

@ifhtml
@include mathjax.texi
@html

This is a mathematical formula  :

@c <mj> \[ x = \frac{-b \pm \sqrt{b^2 - 4 a c}}{2 a} \]

This is an inline mathematical notation : \( \sqrt@{b^2 - 4 a c@} \)

@end html
@end ifhtml
- @include mathjax.texi

  this include add to html page the MathJax javascript & configuration

- @c <mj> \[ x = \frac{-b \pm \sqrt{b^2 - 4 a c}}{2 a} \]

  to include a formula in the page it must be include in backslash brackets -> \{ \}
  To avoid to add the escape character "@" in front of each braket it is necessary
  to declare in front of the formula the tag "@c <mj> "

- This is an inline mathematical notation : \( \sqrt@{b^2 - 4 a c@} \)

  to include a formula in a line it must be include in backslash brackets -> \( \)
  the brackets "{ }" must be declared with the escape character "@{ @}"

This is the output in the html page :
This is a mathematical formula : This is an inline mathematical notation : \( \sqrt{b^2 - 4 a c} \)