[Scummvm-cvs-logs] SF.net SVN: scummvm: [24954] docs/trunk/docbook/README

fingolfin at users.sourceforge.net fingolfin at users.sourceforge.net
Sat Dec 30 19:26:46 CET 2006


Revision: 24954
          http://scummvm.svn.sourceforge.net/scummvm/?rev=24954&view=rev
Author:   fingolfin
Date:     2006-12-30 10:26:41 -0800 (Sat, 30 Dec 2006)

Log Message:
-----------
Add a simple README

Added Paths:
-----------
    docs/trunk/docbook/README

Added: docs/trunk/docbook/README
===================================================================
--- docs/trunk/docbook/README	                        (rev 0)
+++ docs/trunk/docbook/README	2006-12-30 18:26:41 UTC (rev 24954)
@@ -0,0 +1,60 @@
+What is this?
+=============
+This directory contains DocBook XML (and *not* the old DocBook *SGML*)
+source files for some ScummVM documentation, including the FAQ and some
+(unfinished) drafts for a revised User's Manual and Developer's Guide
+(the latter probably will never be finished now, as the Wiki seems to be
+the place to publish this now).
+
+
+How to transform DocBook XML to HTML/PDF/...
+============================================
+The Makefile currently only will work on my (Fingolfin's) system; I am
+not sure how exactly to make it work on other systems, as I simply don't
+have access to these other systems. If you want to try to "compile"
+these DocBook files, please feel free to contact me, and I'll try my
+best to help you sort it out, if you in return promise me to write down
+the required steps for these docs here.
+
+
+For starters, I recommend reading the "DocBook Crash Course":
+  <http://opensource.bureau-cornavin.com/crash-course/en/crash-course.pdf>
+In particular, it describes two different tool chains to convert DocBook
+to HTML, PDF, etc., and also tells you which packages you need for that
+(on a unix system).
+
+Both toolchains can be used for our purposes; the Makefile by default
+uses the "old" docbook-utils / jadetex chain. But there are also rules
+for using the newer XSLT+FOP chain: Just invoke
+  make manual.xsl.html
+to use xsltproc + fop.
+
+I have no idea how to proceed on Windows; probably your best bet is using
+CygWin. I added a link that seems helpful to the link section below.
+
+
+What needs to be done?
+======================
+* Make the build system work on more systems (i.e. not just mine)
+* Document how to build the docs, i.e. write a simple step-by-step guide
+  that tells people how to setup a toolchain. Maybe it's sufficient to
+  link to some external source for this...
+  We should try to cover at least OSX, "Debian style" systems, "Red Hat
+  style" systems, and Windows.
+* Then, work on the docs themselves, in particular the User's Guide ;-)
+
+
+Some links
+==========
+
+DocBook homepage
+<http://www.docbook.org/>
+
+Writing Documentation Using DocBook: A Crash Course.
+<http://opensource.bureau-cornavin.com/crash-course/en/crash-course.pdf>
+
+Docbook Basics and References
+<http://www.dpawson.co.uk/docbook/reference.html>
+
+Documention with DocBook on Win32
+<http://www.codeproject.com/winhelp/docbook_howto.asp>


Property changes on: docs/trunk/docbook/README
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:keywords
   + Date Rev Author URL Id
Name: svn:eol-style
   + native


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




More information about the Scummvm-git-logs mailing list