Skip to content

Commit

Permalink
Improved documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Bora Software committed Dec 12, 2018
1 parent 56cae6e commit f0335e5
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,25 @@ the aim of providing the smallest set of schema elements and the easiest
learning curve.

The BDML source pack contains:
* the bdml.xsd definition;
* the BdmlHtml.xsl XSLT 1.0 transform;
* a set of example CSS stylesheets;
* syntax highlighting Javascript files.
* the bdml.xsd definition;
* the BdmlHtml.xsl XSLT 1.0 transform;
* a set of example CSS stylesheets;
* syntax highlighting Javascript files.

How to use the BDML source pack:
* download a copy of the source pack;
* copy the 'bdml' folder to your source repository inside the documentation folder;
* create a hierarchy of BDML documentation files that reference BdmlHtml.xsl;
* reference the bdml-html.css CSS file / syntax highlighting files and/or your
own CSS / Javascript in your BDML documentation files;
* view the BDML pages by:
- directly loading the BDML files in your browser; or
- creating a build step that transforms the BDML hierarchy into an HTML
hierarchy via an XSLT 1.0 processor.

If directly loading local BDML files, browser local XSLT file loading will be
need to be enabled. Direct loading is not supported in IE/Edge browsers.

* download a copy of the source pack;
* copy the 'bdml' folder to your source repository inside the documentation
folder;
* create a hierarchy of BDML documentation files that reference BdmlHtml.xsl
and optionally the bdml-html.css CSS file and Javascript files;
* directly load the BDML files in your browser (if loading local files, your browser's local
XSLT file loading will need to be enabled), install the files onto your web server (add the
.bdml file extension to your text/xml mime type in your web server configuration), or
create an AOT build step that transforms the BDML hierarchy into an HTML hierarchy via
an XSLT 1.0 processor.

See the [Balau library](https://github.com/borasoftware/balau) for an example
of usage:
Expand Down

0 comments on commit f0335e5

Please sign in to comment.