Re: [simspark-devel] [Sserver-three-d] Documentation and wikis

[Drew N. <dre...@ya...>]

Hi Simon,

That looks like a very sensible way to deal with the printing/offline issue.  In which case, I would revise the pros of using PDF documentation with TeX as:

* Can (sort of) edit offline

> It looks bad compared to a properly formated TeX document, and there is no Index, but it works.

I think we might be able to create and index using a devoted page.  And there's no way it'll look as good at a TeX document, but as you say the wiki uses different formatting for printable versions.  Here's an example:

http://simspark.sourceforge.net/wiki/index.php?title=Users_Manual&printable=yes

I've had a few off-list emails in support of wiki based documentation and, as yet, nothing against the idea.  I'm new to this group and not someone who should be deciding this kind of thing, so please if you do reply, do so to the group.

Drew.



________________________________
From: Simon Raffeiner <sra...@st...>
To: sim...@li...; Drew Noakes <dr...@dr...>
Cc: Peter Stone <ps...@cs...>; sse...@li...
Sent: Mon, 14 June, 2010 5:21:10
Subject: Re: [simspark-devel] [Sserver-three-d] Documentation and wikis

Sehr geehrter Drew Noakes, 

Am Sonntag 13 Juni 2010 19:12:18 schrieben Sie:

> * Can be printed.
> * Can be viewed offline.

That's actually possible with a Wiki too, just look at how WikiBooks is doing it:

http://en.wikibooks.org/w/index.php?title=Wikijunior:Big_Cats/Complete_Edition&action=edit

This is a special page which includes all other pages as chapters into a single document when viewed, and can then be printed - also into a PDF file. The MediaWiki CSS style will automatically remove the Wiki decorations (menu, logo etc.) if the page is printed.

It looks bad compared to a properly formated TeX document, and there is no Index, but it works.

-- 

mit freundlichen Grüßen/regards/cordiali saluti
Simon Raffeiner

University of Applied Sciences Offenburg, Germany
Department of Computer Science, RoboCup Team