diff --git a/build/documentation/.gitignore b/build/documentation/.gitignore index 90f15a5..cc2afff 100644 --- a/build/documentation/.gitignore +++ b/build/documentation/.gitignore @@ -6,5 +6,7 @@ examples/tidy5.*.txt # The license file needs to copies to examples for \include examples/LICENSE.md +# file generates from xsl +examples/quickref_include.html diff --git a/build/documentation/build_docs.sh b/build/documentation/build_docs.sh index 8c7e8ff..62254d2 100755 --- a/build/documentation/build_docs.sh +++ b/build/documentation/build_docs.sh @@ -71,6 +71,7 @@ if [ "$BUILD_XSLT" -eq 1 ]; then # 'quickref.html' xsltproc "quickref.xsl" "tidy-config.xml" > "$OUTP_DIR/quickref.html" + xsltproc "quickref.include.xsl" "tidy-config.xml" > ./examples/quickref_include.html # 'tidy.1' xsltproc "tidy1.xsl" "$tidy-help.xml" > "$OUTP_DIR/tidy.1" @@ -121,11 +122,12 @@ if [ "$BUILD_API" -eq 1 ]; then # - which are then passed to doxygen as stdin (instead of the path to a config.file) ( cat "$DOXY_CFG"; \ echo "PROJECT_NUMBER=$TIDY_VERSION"; \ - echo "HTML_EXTRA_FILES=$OUTP_DIR/quickref.html ./examples/tidy5.help.txt ./examples/tidy5.config.txt"; ) \ + echo "HTML_EXTRA_FILES= ./examples/tidy5.help.txt ./examples/tidy5.config.txt"; ) \ | doxygen - > /dev/null # cleanup - rm "./examples/tidy5.cmd.txt" + rm "./examples/tidy5.help.txt" + rm "./examples/tidy5.config.txt" rm "./examples/LICENSE.md" ## create zip file of docs diff --git a/build/documentation/pages/main_page.dox b/build/documentation/pages/main_page.dox index cc3e6fb..4fceef9 100644 --- a/build/documentation/pages/main_page.dox +++ b/build/documentation/pages/main_page.dox @@ -48,7 +48,9 @@ is converted to - \ref todo +\page quickref Quick Reference +\htmlinclude quickref_include.html */ \ No newline at end of file diff --git a/build/documentation/quickref.include.xsl b/build/documentation/quickref.include.xsl new file mode 100644 index 0000000..5f3c990 --- /dev/null +++ b/build/documentation/quickref.include.xsl @@ -0,0 +1,234 @@ + + + + + + + + + + +

Option Groups

+ + + + + +
+ + + + + + + + + + + + + markup + HTML, XHTML, XML + MarkupHeader + + + diagnostics + Diagnostics + DiagnosticsHeader + + + print + Pretty Print + PrettyPrintHeader + + + encoding + Character Encoding + EncodingHeader + + + misc + Miscellaneous + MiscellaneousHeader + +
+
+ + + + + + markup + HTML, XHTML, XML + MarkupReference + + + diagnostics + Diagnostics + DiagnosticsReference + + + print + Pretty Print + PrettyPrintReference + + + encoding + Character Encoding + EncodingReference + + + misc + Miscellaneous + MiscellaneousReference + +
+
+ + + + + + + + + Options + Top + + + + + + + + + + + + + - + + + + + + +   + + + + + + + + + + +   + + + + Options Reference + + + +   + + + + + + + + + + Top + + + Type:
+ + + + Default: + + + Default: - + + + + + +
Example: +
+ +
Example: - +
+
+ + + + + +
+
+
+ + + + + + + + +   + +
+
+ + + + Option + Type + Default + + + + + + + + + + + + + + + +
diff --git a/build/documentation/style.css b/build/documentation/style.css index f96a5a2..b8c4fc8 100644 --- a/build/documentation/style.css +++ b/build/documentation/style.css @@ -185,4 +185,35 @@ dl.bug dl.section dd { margin-bottom: 6px; +} + + +/* Quickref */ +table.quickref { + font-size: 10pt; + font-family: monospace; +} +table td.h2 { + background-color: #333333; + color: #eeeeee; +} +table td.h3 { + background-color: #333333; + color: #eeeeee; + padding: 8px; + border-top-left-radius: 8px; +} +table td.h3top { + background-color: #333333; + padding: 8px; + border-top-right-radius: 8px; + text-align: right; +} +.h3topa { + color: #333333; +} + + +table td.tabletitle { + background-color: #cccccc; } \ No newline at end of file