Release 1.03.343

This is the first full release of version 1.03 of the PRM-in-XML documentation system.

This release has been developed from the 1.02 version over the course of about 2 years, with many new features and much wider testing.

The tool is released for RISC OS and POSIX systems. On both types of system, the tool works in similar ways to allow documentation to be processed from PRM-in-XML format to HTML and some other formats.

Significant changes in this release over 1.02.64:

• Can generate HTML 5/CSS content, which is suitable for use as paged media content such as PDF.
• Can be styled in a number of different ways to present the content in different forms - in particular a RISC OS 3 style PRM, RISC OS 2 style PRM, and a more modern style are available.
• Still supports output to plain HTML in the form of unstyled tables for compatibility with legacy RISC OS browsers.
• Has documentation in the docs directory within the tool.
• Includes some simple example output from the manual tests which show how the content is laid out.
• RISC OS distribution includes the necessary binaries (perl, xsltproc, xmllint) to process documents.

Summary of new and changed elements (see docs/PRMinXML.txt for more details):

• API declarations are more consistent, which consistent use of sections within them.
• New input, key and mouse elements to represent input actions.
• New actionbutton element to complement the menuoption element.
• offset-table and message-table elements can now be supplied with data sizes.
• New definition-table to avoid overloading of the value-table (which is intended to define numeric values).
• New alternates element to allow for non-optional alternations in command definitions.
• reference elements for SWIs now prefix with the text SWI.
• image elements are better supported and allow multiple in a row.
• Indexed content now supports cover and front-matter to be specified.
• New compatibility, version-table and version elements allow interfaces to state their evolution over time, or through different suppliers.

Release 1.03.65.html5-css.267

Development release of the HTML 5 branch, which allows layout using different styles using CSS.

• New html5 transformation uses different CSS styles to control rendering.
• CSS styles can be controlled by adding different variants on top of the main style - RISC OS 2 style, or with different fonts, etc.

Changes since 1.03.65.html5-css.258:

• Rebuilt perl, with fix for memory corruption when using 'long' paths.
• Updated README.md with links to the downloads, advanced usage, some typo fixes.
• Checked the documentation files for spelling and grammar errors.
• New CSSVariants.md document with details of the built in variants.
• Updated default format to html5.

Release 1.03.65.html5-css.258

Development release of the HTML 5 branch, which allows layout using different styles using CSS.

• New html5 transformation uses different CSS styles to control rendering.
• CSS styles can be controlled by adding different variants on top of the main style - RISC OS 2 style, or with different fonts, etc.

Changes since 1.03.65.html5-css.251:

• Include perl within the RISC OS release, to use explicitly.
• Include xsltproc and xmllint within the RISC OS release, saving the user from downloading them.
• Improved documentation for use on RISC OS.

Release 1.03.65.html5-css.251

Development release of the HTML 5 branch, which allows layout using different styles using CSS.

• New html5 transformation uses different CSS styles to control rendering.
• CSS styles can be controlled by adding different variants on top of the main style - RISC OS 2 style, or with different fonts, etc.

Changes since 1.03.65.html5-css.222:

• Definitions including a reason attribute, now include this in the heading in both HTML and HTML 5 transformations.
• HTML 5 variant modern added, to give a more modern look to the manuals.
• HTML 5 variant packed-definitions added, to make the definition entries less sparse.
• CSS for body and headings no longer defaults to monospace.
• New body and heading fonts for Noto Sans, and new headings fonts Saira and Oswald.
• Improved handling of headings and tables to avoid splitting in PDFs.

Fixes since 1.03.65.html5-css.222:

• definition-table headings are generated consistently.
• Error reports from the tool now include a reason field in the backtrace, if one was present.
• docgroup implementation is now consistently used from the chapter, not the root element.
• Indexes now handle the offset and offset-base better.
• Indexes now sort reason code numbers by their value, rather than alphabetically.
• Index headings repeat on continuation pages.
• Tool correctly reports its name and the location of documentation.

Release 1.03.65.html5-css.222

Development release of the HTML 5 branch, which allows layout using different styles using CSS.

• New html5 transformation uses different CSS styles to control rendering.
• CSS styles can be controlled by adding different variants on top of the main style - RISC OS 2 style, or with different fonts, etc.

Changes since 1.03.65.html5-css.179:

• compatibility/version-table/version elements have been added.
• strong and em are better supported, and should be differentiated with Fraunces font.
• alternates element allows alternative parameters which are not optional (similar to <optional alternates=true>)
• Offset table alignments are now left, and a CSS variant allows them to align right.
• image elements are more reliable and can be positioned horizontally; gif format explicitly supported.
• html transform now supplies the title properly (previously might omit the title in indexed documents).
• Indexed generation now supports front-matter, and automatic cover page generation.
• Front-matter pages are styled for title, dedication, copyright and epigraph.
• reference elements which supply explicit text no longer implicitly prefix with the reference type prefix.

Release 1.03.65.html5-css.179

Development release of the HTML 5 branch, which allows layout using different styles using CSS.

• New html5 transformation uses different CSS styles to control rendering.
• CSS styles can be controlled by adding different variants on top of the main style - RISC OS 2 style, or with different fonts, etc.

Changes since 1.03.65.html5-css.176:

• Explicit testing of Linux Mint 18 and 20.
• Fix for failure to generate content of the indices in the indexed content when the source path includes spaces.

Release 1.03.65.html5-css.176

Development release of the HTML 5 branch, which allows layout using different styles using CSS.

• New html5 transformation uses different CSS styles to control rendering.
• CSS styles can be controlled by adding different variants on top of the main style - RISC OS 2 style, or with different fonts, etc.

Changes since 1.03.65.html5-css.105:

• Added: New input element for key and mouse input.
• Added: New actionbutton element for user interface buttons.
• Added: New definition-table element for textual definitions.
• Added: &ellipsis; entity.
• Changed: data-size attribute on offset and message elements.
• Changed: state attribute on offset and message elements for reserved and undefined data.
• Changed: vector-definition can now report its mode as being IRQ.
• Changed: filename element now has a type attribute for the format of the filename.
• Changed: chapter can now describe the documentation group it belongs to.
• Changed: reference can now refer to a chapter as well as inline elements.
• Changed: HTML 5 indexed document generation can now pass through document groups and part numbers to the edge index and footers.
• Changed: HTML 5 indexed documents now pass through chapters numbers.
• Changed: HTML 5 indexed interfaces are now laid out better and can include descriptions, and references in the page header.
• Fixed: system-output is now an inline element, rather than block.
• Fixed: bit elements no longer repeat names when states are supplied.
• Fixed: HTML 5 transform lays out use blocks better in PDFs (no longer forces a new page).
• Fixed: HTML 5 transform generates bookmarks in the PDF much better.
• Fixed: HTML 5 transform forces chapters on to right pages.
• Fixed: HTML 5 transform no longer forces breaks when prose pargraphs are used before definition blocks.

Release 1.02.65

This is the first recent public git release of the PRM-in-XML tool.
The tool is released for RISC OS and POSIX systems. On both types of system the tool works in similar ways to allow documentation to be processed from PRM-in-XML format to HTML and some other formats.

The release:

• Supports output to HTML in the form of unstyled tables for compatibility with RISC OS browsers.
• Has been tested on RISC OS, macOS, and common Linux distributions.
• Has documentation in the docs directory within the tool.
• Includes some simple example output from the manual tests which show how the content is layed out.

Changes since 1.02.64:

• Fix: riscos-prminxml --version now reports the correct version number.

Release 1.03.65.html5-css.105

Development release of the HTML 5 branch, which allows layout using different styles using CSS.

• New html5 transformation uses different CSS styles to control rendering.
• CSS styles can be controlled by adding different variants on top of the main style - RISC OS 2 style, or with different fonts, etc.

Changes since 1.03.64.html5-css.103:

• Fix: riscos-prminxml -version now reports the correct version number.
• Fix: Default catalog version is now 1.03, rather than 1.02.

Release 1.03.64.html5-css.103

Development release of the HTML 5 branch, which allows layout using different styles using CSS.

• New html5 transformation uses different CSS styles to control rendering.
• CSS styles can be controlled by adding different variants on top of the main style - RISC OS 2 style, or with different fonts, etc.