From df635390f9a5a352d5c712482638af09ac454336 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=BCnther=20Brammer?= Date: Fri, 9 Sep 2011 21:36:03 +0200 Subject: [PATCH] docs: Improvements to chm generation and in-browser xslt preview --- docs/Makefile | 7 ++++--- docs/Template.de.hhp | 2 +- docs/Template.hhp | 2 +- docs/clonk.xsl | 37 +++++++++++++++---------------------- docs/doku.css | 24 +++++++++++------------- docs/hhc.xsl | 6 +++--- docs/sdk/index.xml | 2 +- 7 files changed, 36 insertions(+), 44 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 8aad46ac9..168caee69 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -92,10 +92,10 @@ sdk-de/%.xml: sdk/%.xml de.mo xml2po.py clonk.py define run-xslt @echo generate $@ -@xsltproc -o $@ --param webnotes $(webnotes) --param fileext "'.html'" $(XSLTFLAGS) $(stylesheet) $< +@xsltproc -o $@ --param chm $(chm) --param fileext "'.html'" $(XSLTFLAGS) $(stylesheet) $< endef -online/%: webnotes=1 -chm/%: webnotes=0 +online/%: chm=0 +chm/%: chm=1 online/en/sdk/%.html: sdk/%.xml $(stylesheet) ; $(run-xslt) online/de/sdk/%.html: sdk-de/%.xml $(stylesheet) ; $(run-xslt) chm/en/sdk/%.html: sdk/%.xml $(stylesheet) ; $(run-xslt) @@ -118,3 +118,4 @@ chm/en/Developer.chm: chm/en/Output.hhp chm/en/Output.hhk chm/en/Output.hhc $(ad "$(HHC)" $< chm/de/Entwickler.chm: chm/de/Output.hhp chm/de/Output.hhk chm/de/Output.hhc $(addprefix chm/de/, $(sdk-dirs) images $(htmlfiles) $(extra-files-chm)) "$(HHC)" $< + diff --git a/docs/Template.de.hhp b/docs/Template.de.hhp index cc58768c3..d46ee4d80 100644 --- a/docs/Template.de.hhp +++ b/docs/Template.de.hhp @@ -2,7 +2,7 @@ Compatibility=1.1 or later Compiled file=Entwickler.chm Contents file=Output.hhc -Default topic=sdk\content.html +Default topic=sdk\index.html Display compile progress=No Full-text search=Yes Index file=Output.hhk diff --git a/docs/Template.hhp b/docs/Template.hhp index 533718fcf..7de075b30 100644 --- a/docs/Template.hhp +++ b/docs/Template.hhp @@ -2,7 +2,7 @@ Compatibility=1.1 or later Compiled file=Developer.chm Contents file=Output.hhc -Default topic=sdk\content.html +Default topic=sdk\index.html Display compile progress=No Full-text search=Yes Index file=Output.hhk diff --git a/docs/clonk.xsl b/docs/clonk.xsl index 7abb92ecf..58b1f00ec 100644 --- a/docs/clonk.xsl +++ b/docs/clonk.xsl @@ -6,7 +6,7 @@ - + @@ -14,7 +14,7 @@ doku.css - + @@ -47,21 +47,8 @@ - - - - - + - @@ -76,13 +63,19 @@ - -
-
+ + chm -
+ + + +
+
+ +
+ diff --git a/docs/doku.css b/docs/doku.css index ce4eecbf4..60240b9bb 100644 --- a/docs/doku.css +++ b/docs/doku.css @@ -4,9 +4,6 @@ body { font-family: Verdana, Arial, 'Trebuchet MS'; background-color: white; color: black; -} - -body { font-size: small; line-height: 1.6em; } @@ -32,6 +29,16 @@ body { margin-bottom: 10px; } +#chm { + margin: 1em; +} + +#content { + padding: 0 1em; + margin: 0 auto; + position: absolute; top: 145px; left: 300px; right: 0; bottom: 0; overflow: auto; +} + .text, pre.code, ul, ol, dl { padding-top: 5px; padding-bottom: 5px; @@ -43,15 +50,6 @@ div.fnsyntax { margin-left: 1em; } -#toc { -} - -#content { - padding: 0 1em; - margin: 0 auto; - position: absolute; top: 145px; left: 300px; right: 0; bottom: 0; overflow: auto; -} - div.example { margin-top: 12px; margin-bottom: 36px; @@ -66,7 +64,7 @@ dd { margin-right: 6px; } -img#cpem { +img.cpem { float: left; margin: 12px; } diff --git a/docs/hhc.xsl b/docs/hhc.xsl index a148b2ece..dbc226745 100644 --- a/docs/hhc.xsl +++ b/docs/hhc.xsl @@ -31,11 +31,11 @@ and needs at least some of the whitespace added with xsl:text below, and perhaps
  • - + - - sdk\ + + sdk\ diff --git a/docs/sdk/index.xml b/docs/sdk/index.xml index 4bae3783c..108e2fe61 100644 --- a/docs/sdk/index.xml +++ b/docs/sdk/index.xml @@ -6,7 +6,7 @@ OpenClonk Documentation OpenClonk Documentation - + Welcome to the developer documentation for the creation of custom game content. This documentation includes a thorough reference of the game data and its file hierarchy.
    Also included is a script reference which explains the syntax and semantics of Clonk's own scripting language - C4Script. In the script reference, all functions, constants and callbacks that are available for the scripter are documented with example usages.