Skip to content

Commit f0335e5

Browse files
author
Bora Software
committed
Improved documentation.
1 parent 56cae6e commit f0335e5

1 file changed

Lines changed: 16 additions & 14 deletions

File tree

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,25 @@ the aim of providing the smallest set of schema elements and the easiest
1212
learning curve.
1313

1414
The BDML source pack contains:
15-
* the bdml.xsd definition;
16-
* the BdmlHtml.xsl XSLT 1.0 transform;
17-
* a set of example CSS stylesheets;
18-
* syntax highlighting Javascript files.
15+
* the bdml.xsd definition;
16+
* the BdmlHtml.xsl XSLT 1.0 transform;
17+
* a set of example CSS stylesheets;
18+
* syntax highlighting Javascript files.
1919

2020
How to use the BDML source pack:
21+
* download a copy of the source pack;
22+
* copy the 'bdml' folder to your source repository inside the documentation folder;
23+
* create a hierarchy of BDML documentation files that reference BdmlHtml.xsl;
24+
* reference the bdml-html.css CSS file / syntax highlighting files and/or your
25+
own CSS / Javascript in your BDML documentation files;
26+
* view the BDML pages by:
27+
- directly loading the BDML files in your browser; or
28+
- creating a build step that transforms the BDML hierarchy into an HTML
29+
hierarchy via an XSLT 1.0 processor.
30+
31+
If directly loading local BDML files, browser local XSLT file loading will be
32+
need to be enabled. Direct loading is not supported in IE/Edge browsers.
2133

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

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

0 commit comments

Comments
 (0)