documentation tidying

pgfearo · Sep 13, 2015 · 4334cb8 · 4334cb8
1 parent 4b1f6f2
commit 4334cb8
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 22 deletions.
diff --git a/.gitignore b/.gitignore
@@ -174,3 +174,7 @@ app/xsl/basic-xslver3.xsl
 app/shell-cmd/basic.sh
 
 app/output/theme.css
+
+app/samples/xms-out/nolines.xml.html
+
+output/theme.css
diff --git a/app/samples/xms-out/theme.css b/app/samples/xms-out/theme.css
@@ -12,7 +12,7 @@ p.spectrum, pre.spectrum {
     display: block;
     border: none thin;
     border-color: #405075;
-    background-color:#002b36;
+    background-color:#FFFFFF;
     padding: 2px 2px 2px 5px;
     margin-bottom:5px;
 
@@ -25,13 +25,13 @@ div.spectrum-toc {
     display: block;
     border: none thin;
     border-color: #405075;
-    background-color:#002b36;
+    background-color:#FFFFFF;
     padding: 2px;
 
 }
 
 ul.base1, ul.spectrum-toc {
-color:#93a1a1;
+color:#1049a9;
   }
 
   ul.spectrum-toc > li {
@@ -62,31 +62,31 @@ color:#93a1a1;
   }
 
   span.ww
- {background-color: #073642; }
+ {background-color: #FFFFFF; }
  span.base01, span.eq-equ, span.z, span.sc, span.scx, span.ec, span.es, span.ez, span.atneq
- {color: #586e75; }
+ {color: #006C51; }
  span.base03, span.ww:not(:hover), span.txt:not(:hover), span.cm:not(:hover), span.pi:not(:hover)
- {background-color: #002b36; }
+ {background-color: #FFFFFF; }
  span.base0, span.txt, span.cd
- {color: #839496; }
+ {color: #00685A; }
  span.base1, span.literal
- {color: #93a1a1; }
+ {color: #1049a9; }
  span.yellow, span.op, span.type-op, span.if, span.higher, span.step, span.whitespace, span.quantifier, span.parenthesis
- {color: #b58900; }
+ {color: #534ed9; }
  span.orange, span.function, span.pname
- {color: #cb4b16; }
+ {color: #EC0033; }
  span.red, span.fname, span.tname, span.tcall
- {color: #dc322f; }
+ {color: #a66b00; }
  span.magenta, span.vname, span.variable, span.external
- {color: #d33682; }
+ {color: #7608aa; }
  span.violet, span.qname, span.type-name, span.unclosed, span.en, span.cl, span.href
- {color: #6c71c4; }
+ {color: #4c036e; }
  span.blue, span.enxsl, span.clxsl, span.enx, span.filter, span.node, span.node-type
- {color: #268bd2; }
+ {color: #052c6e; }
  span.cyan, span.atn, span.numeric, span.pi, span.dt, span.axis, span.context, span.bracedq, span.property
- {color: #2aa198; }
+ {color: #920031; }
  span.green, span.cm, span.comment, span.av, span.type
- {color: #859900; }
+ {color: #8a8a8a; }
 
 
 a.solar {

diff --git a/app/shell-cmd/xslformat.sh b/app/shell-cmd/xslformat.sh
@@ -42,6 +42,8 @@ if [[ $# -eq 0 || $1 == '-?' ]]
         newpath=$(dirname $relpath)/xmsxsl-out
         java -jar $SAXONJAR -xsl:$XMLSPECTRUM -it:main sourcepath=$relpath output-path=$newpath output-method=text $2 $3 $4 $5 $6 $7 $8 $9
         newfilepath=$newpath/$filename.text
+        echo
+        echo "---------------------------"
         cat $newfilepath
         echo "---------------------------"
         echo "output file is at: $newfilepath"

diff --git a/readme.md b/readme.md
@@ -1,10 +1,10 @@
 XMLSpectrum
 ===========================
 
-###Syntax-highlighter and formatter for XQuery 3.0 , XSLT 3.0 and XPath 3.0 and any hosting XML
+###Syntax-highlighter for XQuery 3.0 , XSLT 3.0 and XPath 3.0 and XML
 
 ###Why
-1. Many syntax-highlighters rely on generic processors that fail to accurately render XQuery or XPath 2.0, whether it is standalone or embedded in XML, such as XSLT, XSD, Schematron etc. 
+1. Many generic syntax-highlighters can't render XQuery or XPath 2.0/3.0 reliably, whether it is standalone or embedded in XML, such as XSLT, XSD, XProc, Schematron etc. 
 
 2. The 'pretty-print' options of many XML editors can not align XML attributes and their contents properly. This omission is especially critical for the readability of XPath 2.0/3.0.
 
@@ -118,13 +118,18 @@ Recursively processes all XSLT modules from a top-level stylesheet in a multi-fi
 
 ###Command Line
 
-Sample bash and doc scripts are included as a convenience in the shell-cmd directory. These scripts invoke the Saxon XSLT processor with the highlight-file.xsl stylesheet and perform basic file path resolving and checking on the input file (supplied as the first argument when calling the script) for the current directory - not the script or directory. 
+Sample bash and doc scripts are included as a convenience in the app/shell-cmd directory. These scripts invoke the Saxon XSLT processor with the highlight-file.xsl stylesheet and perform basic file path resolving and checking on the input file (supplied as the first argument when calling the script) for the current directory - not the script or directory. 
 
 | script    |  description                                                |
 | ----------| ----------------------------------------------------------- |
-| xmlspec   |  syntax highlighting of XSLT/XML or XQuery                  |
-| xslprint  | syntax highlighting and TOC for multi-module XSLT project   |
-| xslformat | reformatting of source for XSLT/XML                         |
+| xmlspec   |  HTML syntax highlighting of XSLT/XML or XQuery                  |
+| xslprint  | HTML syntax highlighting and TOC for multi-module XSLT project   |
+| xslformat | reformatting of source for XSLT/XML - output is formatted XML                         |
+
+Examples:
+
+    1. xslformat.sh nolines.xml force-newline=yes
+    2. xmlspec.sh nolines.xml force-newline=yes color-theme=pg-light indent=2
 
 ###GUI