From f0335e51681f2b42e2d666fcd2eb790cce2382af Mon Sep 17 00:00:00 2001 From: Bora Software Date: Wed, 12 Dec 2018 09:42:27 +0000 Subject: [PATCH] Improved documentation. --- README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 76cdb3a..ccd3988 100644 --- a/README.md +++ b/README.md @@ -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: