Publish/MarkupDetail

From J Wiki
Jump to: navigation, search
Publish | Overview | Markup Summary Markup Detail | Styles | Images Tables | Examples


Standard Tags

<author>

This gives the Author property in the PDF file, as shown by selecting File|Document Properties in Adobe Reader. For example:

<author>Peter Simple</author>

<b>

Set bold font, as in HTML.

<br/>

This is a line break, i.e. start a new line, but not a new paragraph. This is the same as HTML <br>.

Note that in source text, linefeeds are ignored, i.e. are treated as blanks.

<comment>

Any comment text is ignored.

<group>

This tries to fit all output within the group on a single page. It is essentially an optional newpage.

If the output within a group block can fit on a single page, then the group tag has no effect. Otherwise, a newpage is given so that the group starts on a new page. A group block can include any tags, except for <h0>, <h1>, <newpage/> and <toc>.

<h1>...<h6>

These are section headers.

The <h1> header begins a new top-level section, on a new page. Pages before the first <h1> header are numbered as (i), (ii), (iii) etc. while pages after the first <h1> header numbered as 1, 2, 3 etc.

Header tags are numbered. For example, if starting section 4, then:

<h1>This section<h1>
<h2>This paragraph</h2>
<h3>This sub paragraph</h3>

will be numbered as:

4 This section
4.1 This paragraph
4.1.1 This sub paragraph

The text in header tags may have more than one line. The second line and subsequent lines may be formatted differently from the first. For example, if the second line format were plain text:

This header line 1
(and line 2)

would display like:

4.1 This header line 1
    (and line 2)

<h0>

Set h0 (front page) font style.

<i>

Set italic font, as in HTML.

<image>

This specifies an image file, i.e. bitmap, jpeg or J plot. See Images.

<include>

Includes another file (text, style or script). For example, this allows a report to be built from several text files. Note that files called master.sty or master.ijs are included automatically.

<j>

Executes a J expression, and inserts the result in the text file.

<j>gettable 'mytable.dat'</j>

where the J expression returns the required information, for example:

   gettable 'mytable.dat'
<table>
  <col>one two three four</col>
  <row>alpha beta</row>
  <data>2 3 5 7 ... </data>
</table>

<link>

This is an external reference as an URL, for example:

For more information, see <link>http://www.jsoftware.com</link>.

The color of the link is given in LCOLOR, default dark blue.

<list>

Lists are not yet implemented...

This is a list (bulleted, numbered, etc).

<newpage/>

Start a new page.

<para>

This defines a paragraph, and is needed for applying a style to a paragraph.

<pre>

This is preformatted (i.e. fixed-font), as for code. No

other markup is recognized in

, so the <>
characters should be used instead of their html
equivalents. For example, use this to enter code:

<pre>
<pre>
  (i. >./) ?~10

<skip>

This is a vertical space. Default size is that of the normal font. Any value is a multiple of the default. For example, the following skips 3 lines:

<skip>3</skip>

<table>

Defines a table. Sub tags are:

<align><col><data><high><row><top>

See Tables.

<title>

This gives the Title property in the PDF file, as shown by selecting File|Document Properties in Adobe Reader. For example:

<title>My Publish</title>

<toc>

This builds a Table of Contents. This is generated automatically from the <h...> headers, up to a given level, default 3. That is, <h1>, <h2>, and <h3> headers are included.

The <toc> tag must be given before the first <h1> tag.

The value is used as the header. For example:

<toc align=center>Document Contents</toc>

Tag Styles

Tags may be given with styles, see separate section on Styles. Any tag may take any style, though in many cases, the style will have no affect.

For example, the following displays a jpeg centered on the page.

<image center>toucan.jpg</image>

Special Characters

The following special characters are recognized in markup. They are not needed within <pre></pre> tags.

||>||>||
||<||<||
|| ||space||
||˜||~||

The tilde (~) character is used for hyphenation . A word that contains a tilde may be hyphenated at the tilde - otherwise, the tildes do not display.