github-actions
released this
20 Aug 18:17
·
3 commits
to master
since this release
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
andmouse
elements to represent input actions. - New
actionbutton
element to complement themenuoption
element. offset-table
andmessage-table
elements can now be supplied with data sizes.- New
definition-table
to avoid overloading of thevalue-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 textSWI
.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
andversion
elements allow interfaces to state their evolution over time, or through different suppliers.