Voyager Support - Revision history

Ktk at 21:45, 16 July 2007

2007-07-16T21:45:31Z

← Older revision		Revision as of 23:45, 16 July 2007
Line 29:		Line 29:
	* Do not worry about the online versions, they are done by some scripts. Just make sure your own copy builds correctly in HTML before you commit it.		* Do not worry about the online versions, they are done by some scripts. Just make sure your own copy builds correctly in HTML before you commit it.
	* Do not forget to commit images as well to the Subversion, in case you added some.		* Do not forget to commit images as well to the Subversion, in case you added some.

			===Building DOV on OS/2===
			Fix me :-)


	==ToDo==		==ToDo==

Doodle: /* Triton */

2007-01-23T15:05:09Z

Triton

← Older revision		Revision as of 17:05, 23 January 2007
Line 43:		Line 43:

	====Triton====		====Triton====
	* [http://svn.netlabs.org/v_triton/browser/trunk/Docs/mmio-general.pdf MMIO General] - PDF		* [http://svn.netlabs.org/v_triton/browser/trunk/Docs/mmio-general.pdf MMIO General] - in PDF format
			* [http://svn.netlabs.org/v_triton/browser/trunk/Docs/mmio-general.odt MMIO General] - in OpenOffice 2.0 format
	* Author: Peter Kocsis, <tt>doodle at netlabs.org</tt>, Doodle on irc://irc.netlabs.org/netlabs		* Author: Peter Kocsis, <tt>doodle at netlabs.org</tt>, Doodle on irc://irc.netlabs.org/netlabs

Doodle: Fixed email address of Doodle and fixed link to mmio-general doc.

2007-01-23T14:57:10Z

Fixed email address of Doodle and fixed link to mmio-general doc.

← Older revision		Revision as of 16:57, 23 January 2007
Line 43:		Line 43:

	====Triton====		====Triton====
	* [http://svn.netlabs.org/v_triton/browser/trunk/Docs/mmio-general.~~odt~~ MMIO General] - ~~OpenOffice.org~~		* [http://svn.netlabs.org/v_triton/browser/trunk/Docs/mmio-general.pdf MMIO General] - PDF
	* Author: Peter Kocsis, <tt>~~FIXME~~</tt>, Doodle on irc://irc.netlabs.org/netlabs		* Author: Peter Kocsis, <tt>doodle at netlabs.org</tt>, Doodle on irc://irc.netlabs.org/netlabs

	===Object-Oriented Interface Design (CUA)===		===Object-Oriented Interface Design (CUA)===

MrFawlty: Some minor textual updates

2006-12-29T17:11:37Z

Some minor textual updates

Cinc: /* Netlabs Object Model */

2006-12-29T08:16:10Z

Netlabs Object Model

← Older revision		Revision as of 10:16, 29 December 2006
Line 36:		Line 36:
	====Netlabs Object Model====		====Netlabs Object Model====
	* [ftp://ftp.netlabs.org/pub/misc/cinc/voyager/Object-design.pdf Object Design]		* [ftp://ftp.netlabs.org/pub/misc/cinc/voyager/Object-design.pdf Object Design]
	* Author: Chris Wohlgemuth, <tt>cinc at netlabs.org</tt>, Cinc on irc://irc.netlabs.org/netlabs		* Author: Chris Wohlgemuth, <tt>cinc-ml at netlabs.org</tt>, Cinc on irc://irc.netlabs.org/netlabs

	====Desktop====		====Desktop====

Cinc: /* Desktop */

2006-12-29T08:15:53Z

Desktop

← Older revision		Revision as of 10:15, 29 December 2006
Line 40:		Line 40:
	====Desktop====		====Desktop====
	* [ftp://ftp.netlabs.org/pub/misc/cinc/voyager/Desktop-design.pdf Desktop Design]		* [ftp://ftp.netlabs.org/pub/misc/cinc/voyager/Desktop-design.pdf Desktop Design]
	* Author: Chris Wohlgemuth, <tt>cinc at netlabs.org</tt>, Cinc on irc://irc.netlabs.org/netlabs		* Author: Chris Wohlgemuth, <tt>cinc-ml at netlabs.org</tt>, Cinc on irc://irc.netlabs.org/netlabs

	====Triton====		====Triton====

Ktk at 02:48, 29 December 2006

2006-12-29T02:48:53Z

← Older revision		Revision as of 04:48, 29 December 2006
Line 1:		Line 1:
			[[Category:Voyager]]
	Voyager is a very complex projects and it just can be successful when everyone contributes as good as possible. To make it easier for you to join the project we defined some jobs where you might help.		Voyager is a very complex projects and it just can be successful when everyone contributes as good as possible. To make it easier for you to join the project we defined some jobs where you might help.

Ktk: /* DocBook Syntax */

2006-12-29T02:46:40Z

DocBook Syntax

← Older revision		Revision as of 04:46, 29 December 2006
Line 25:		Line 25:
	* For images one should use PNG versions for the web release and PDF for the PDF edition of the book. See the [http://FIXME mediaobject] example in [http://svn.netlabs.org/v_doc/browser/DOV/ch03.xml Chapter 3]. Please make sure that the PNG versions use a size that makes sense for web publishing. We did not do many tests on PDF yet, we have to see how this works regarding scaling.		* For images one should use PNG versions for the web release and PDF for the PDF edition of the book. See the [http://FIXME mediaobject] example in [http://svn.netlabs.org/v_doc/browser/DOV/ch03.xml Chapter 3]. Please make sure that the PNG versions use a size that makes sense for web publishing. We did not do many tests on PDF yet, we have to see how this works regarding scaling.
	* We use Subversion to keep a history of the document, this also means that the structure of the document should not change unless there is new content. Because of its XML nature, every editor will use its own indenting for the file. The only valid format to commit to Subversion is the indenting of Vex. So in case your editor changes the layout please make sure that Vex did format it before it gets committed, otherwise we get very big changesets!		* We use Subversion to keep a history of the document, this also means that the structure of the document should not change unless there is new content. Because of its XML nature, every editor will use its own indenting for the file. The only valid format to commit to Subversion is the indenting of Vex. So in case your editor changes the layout please make sure that Vex did format it before it gets committed, otherwise we get very big changesets!
			* There is an additional <tt>DOCTYPE</tt> declaration in each chapter, the XSLT for transforming it does not like that because it is also defined in <tt>book.xml</tt>. To create the HTML and the PDF version of the book this line gets stripped out automatically by the build process before the document is transformed.
			* Do not worry about the online versions, they are done by some scripts. Just make sure your own copy builds correctly in HTML before you commit it.
			* Do not forget to commit images as well to the Subversion in case you added some.

	==ToDo==		==ToDo==

Ktk: /* Object-Oriented Interface Design (CUA) */

2006-12-29T02:43:07Z

Object-Oriented Interface Design (CUA)

← Older revision		Revision as of 04:43, 29 December 2006
Line 50:		Line 50:
	* Get the [http://svn.netlabs.org/v_doc/browser/CUA recent version] of this book in our Subversion		* Get the [http://svn.netlabs.org/v_doc/browser/CUA recent version] of this book in our Subversion
	* Install [http://weilbacher.org/Mozilla/builds.html NVU] and open the xhtml file.		* Install [http://weilbacher.org/Mozilla/builds.html NVU] and open the xhtml file.
	* Start to clean it up. The syntax should look like in the beginning, very simple but clean XHTML code, as few <tt><br></tt> as possible, <tt><h1</tt>, <tt><h2></tt> for topic formating and <tt><p></tt> for paragraphs.		* Start to clean it up. The syntax should look like in the beginning, very simple but clean XHTML code, as few <tt>br</tt> as possible, <tt>h1</tt>, <tt>h2</tt> for topic formating and <tt>p</tt> for paragraphs.
	* Kill all table of contents and such things in the XHTML version. We will transform the XHTML to DocBook in a second step and DocBook will take care of that.		* Kill all table of contents and such things in the XHTML version. We will transform the XHTML to DocBook in a second step and DocBook will take care of that.
	* And if you are brave try to reproduce the images, at least those that make sense. This book is still available second hand, use that as a reference. For sure it would greatly help if someone finds a PDF version of the original document (in case that exists). It might get pretty tricky to reproduce some of the images because IBM created some sample applications for it, use what makes sense to you.		* And if you are brave try to reproduce the images, at least those that make sense. This book is still available second hand, use that as a reference. For sure it would greatly help if someone finds a PDF version of the original document (in case that exists). It might get pretty tricky to reproduce some of the images because IBM created some sample applications for it, use what makes sense to you. For sure the images should be taken from a recent OS/2 or eCS system.

Ktk at 02:40, 29 December 2006

2006-12-29T02:40:37Z

← Older revision		Revision as of 04:40, 29 December 2006
Line 6:		Line 6:
	The drawback is that it takes some more time to get into DocBook, in the beginning it is easier to use a WYSIWYG application like OpenOffice.org to create the document. Currently two Voyager developers write their documentation in OpenOffice.org.		The drawback is that it takes some more time to get into DocBook, in the beginning it is easier to use a WYSIWYG application like OpenOffice.org to create the document. Currently two Voyager developers write their documentation in OpenOffice.org.

	So one help would be to keep [The Design of Voyager] up to date with the OpenOffice.org documents of the two developers. Beside this one might also work on an easy to use way on eCS to work with DocBook.		So one help would be to keep [http://voyager.netlabs.org/ The Design of Voyager] up to date with the OpenOffice.org documents of the two developers. Beside this one might also work on an easy to use way on eCS to work with DocBook.


Line 50:		Line 50:
	* Get the [http://svn.netlabs.org/v_doc/browser/CUA recent version] of this book in our Subversion		* Get the [http://svn.netlabs.org/v_doc/browser/CUA recent version] of this book in our Subversion
	* Install [http://weilbacher.org/Mozilla/builds.html NVU] and open the xhtml file.		* Install [http://weilbacher.org/Mozilla/builds.html NVU] and open the xhtml file.
	* Start to clean it up. The syntax should look like in the beginning, very simple but clean XHTML code, as few <tt><br><tt> as possible, <tt><h1</tt>, <tt><h2></tt> for topic formating and <tt><p></tt> for paragraphs.		* Start to clean it up. The syntax should look like in the beginning, very simple but clean XHTML code, as few <tt><br></tt> as possible, <tt><h1</tt>, <tt><h2></tt> for topic formating and <tt><p></tt> for paragraphs.
	* Kill all table of contents and such things in the XHTML version. We will transform the XHTML to DocBook in a second step and DocBook will take care of that.		* Kill all table of contents and such things in the XHTML version. We will transform the XHTML to DocBook in a second step and DocBook will take care of that.
	* And if you are brave try to reproduce the images, at least those that make sense. This book is still available second hand, use that as a reference. For sure it would greatly help if someone finds a PDF version of the original document (in case that exists). It might get pretty tricky to reproduce some of the images because IBM created some sample applications for it, use what makes sense to you.		* And if you are brave try to reproduce the images, at least those that make sense. This book is still available second hand, use that as a reference. For sure it would greatly help if someone finds a PDF version of the original document (in case that exists). It might get pretty tricky to reproduce some of the images because IBM created some sample applications for it, use what makes sense to you.

← Older revision		Revision as of 19:11, 29 December 2006
Line 1:		Line 1:
	[[Category:Voyager]]		[[Category:Voyager]]
	Voyager is a very complex ~~projects~~ and it ~~just~~ can be successful when everyone contributes as good as possible. To make it easier for you to join the project we defined some jobs where you might help.		Voyager is a very complex project and it can only be successful when everyone contributes as good as possible. To make it easier for you to join the project, we defined some jobs where you might be able to help.

	==Documentation==		==Documentation==
	Good documentation is an important part of Voyager. For various reasons we decided to do the documentation in [http://www.docbook.org DocBook]. This is an XML based format used for many publications, O'reilly books are done with that too. Many other open source projects use this format as a base~~, it~~ allows us to create any kind of output out of it like HTML or PDF but also more in the future.		Good documentation is an important part of Voyager. For various reasons we decided to do the documentation in [http://www.docbook.org DocBook]. This is an XML based format used for many publications. O'reilly books are done with that too. Many other open source projects use this format as a base. It allows us to create any kind of output out of it, like HTML or PDF but also more in the future.

	The drawback is that it takes some ~~more~~ time to get into DocBook, in the beginning it is easier to use a WYSIWYG application like OpenOffice.org to create the document. Currently two Voyager developers write their documentation in OpenOffice.org.		The drawback is that it takes some time to get into DocBook, in the beginning it is easier to use a WYSIWYG application like OpenOffice.org to create the document. Currently two Voyager developers write their documentation in OpenOffice.org.

	So one help would be to keep [http://voyager.netlabs.org/ The Design of Voyager] up to date with the OpenOffice.org documents of the two developers. ~~Beside~~ this one might also work on an ~~easy~~ to use ~~way~~ on eCS ~~to work with DocBook~~.		So, one help would be to keep [http://voyager.netlabs.org/ The Design of Voyager] up to date with the OpenOffice.org documents of the two developers. Besides this, one might also work on an 'Easy way to use DocBook on eCS'.


	===DocBook Editors===		===DocBook Editors===
	At ~~the~~ time writing ~~there are~~ the following options available to edit DocBook in an easier way:		At this time of writing, the following options are available to edit DocBook in an easier way:

	* [http://www.eclipse.org Eclipse] with the [http://vex.sourceforge.net/ Vex] and [http://www.xmlbuddy.com/ XMLBuddy] plugin. Vex is open source and XMLBuddy is free in the entry version which is enough for our needs. Unfortunately we do not have an Eclipse port for eCS yet so this requires to work on one of the supported Eclipse platforms right now.		* [http://www.eclipse.org Eclipse] with the [http://vex.sourceforge.net/ Vex] and [http://www.xmlbuddy.com/ XMLBuddy] plugin. Vex is open source and XMLBuddy is free in the entry version which is enough for our needs. Unfortunately we do not have an Eclipse port for eCS yet so this requires to work on one of the supported Eclipse platforms right now.
Line 17:		Line 17:


	At Warpstock Europe 2005 there was also a [http://warpstock.net/WSE2005/Presentations/Presentations/#docbook presentation about DocBook] on eCS by Jarda Kačer and Jirka Kosek. It would be a good idea to work together with those guys to get that ~~to work~~ on eCS as well.		At Warpstock Europe 2005 there was also a [http://warpstock.net/WSE2005/Presentations/Presentations/#docbook presentation about DocBook] on eCS by Jarda Kačer and Jirka Kosek. It would be a good idea to work together with those guys to get that up and running on eCS as well.

	===DocBook Syntax===		===DocBook Syntax===
	The best way to learn DocBook is to have a look at the [http://svn.netlabs.org/v_doc/browser/DOV current book], most of the needed tags are probably already used once. ~~Beside~~ this one should have a look at [http://www.docbook.org/tdg/ DocBook: The Definitive Guide], which is available online or as HTML download.		The best way to learn DocBook is to have a look at the [http://svn.netlabs.org/v_doc/browser/DOV current book], most of the needed tags are probably already used once. Besides this, one should have a look at [http://www.docbook.org/tdg/ DocBook: The Definitive Guide], which is available online or as HTML download.

	Some remarks:		Some remarks:
	* Use [http://www.docbook.org/tdg/en/html/xref.html xref] whenever possible to create a reference to another part of the document. This makes reading the book much more interactive.		* Use [http://www.docbook.org/tdg/en/html/xref.html xref] whenever possible to create a reference to another part of the document. This makes reading the book much more interactive.
	* For images one should use PNG versions for the web release and PDF for the PDF edition of the book. See the [http://FIXME mediaobject] example in [http://svn.netlabs.org/v_doc/browser/DOV/ch03.xml Chapter 3]. Please make sure that the PNG versions use a size that makes sense for web publishing. We did not do many tests on PDF yet~~, we~~ have to see how this works regarding scaling.		* For images one should use PNG versions for the web release and PDF for the PDF edition of the book. See the [http://FIXME mediaobject] example in [http://svn.netlabs.org/v_doc/browser/DOV/ch03.xml Chapter 3]. Please make sure that the PNG versions use a size that makes sense for web publishing. We did not do many tests on PDF yet. We have to see how this works regarding scaling.
	* We use Subversion to keep a history of the document, this also means that the structure of the document should not change unless there is new content. Because of its XML nature, every editor will use its own indenting for the file. The only valid format to commit to Subversion is the indenting of Vex. So in case your editor changes the layout please make sure that Vex did format it before it gets committed, otherwise we get very big changesets!		* We use Subversion to keep a history of the document, this also means that the structure of the document should not change unless there is new content. Because of its XML nature, every editor will use its own indenting for the file. The only valid format to commit to Subversion is the indenting of Vex. So, in case your editor changes the layout, please make sure that Vex did format it before it gets committed, otherwise we get very big changesets!
	* There is an additional <tt>DOCTYPE</tt> declaration in each chapter, the XSLT for transforming it does not like that because it is also defined in <tt>book.xml</tt>. To create the HTML and the PDF version of the book this line gets stripped out automatically by the build process before the document is transformed.		* There is an additional <tt>DOCTYPE</tt> declaration in each chapter, the XSLT for transforming it does not like that because it is also defined in <tt>book.xml</tt>. To create the HTML and the PDF version of the book this line gets stripped out automatically by the build process before the document is transformed.
	* Do not worry about the online versions, they are done by some scripts. Just make sure your own copy builds correctly in HTML before you commit it.		* Do not worry about the online versions, they are done by some scripts. Just make sure your own copy builds correctly in HTML before you commit it.
	* Do not forget to commit images as well to the Subversion in case you added some.		* Do not forget to commit images as well to the Subversion, in case you added some.

	==ToDo==		==ToDo==
	This is a list of documents that need ~~to get maintained~~.		This is a list of documents that need maintenance.

	===The Design of Voyager===		===The Design of Voyager===
Line 50:		Line 50:
	* Object-Oriented Interface Design - IBM Common User Access Guidelines ISBN 1-56529-170-0		* Object-Oriented Interface Design - IBM Common User Access Guidelines ISBN 1-56529-170-0

	We never found a PDF version of this book, just a very poor online HTML version. With the help of some scripts we assembled a standalone version of this book. Unfortunately the HTML syntax is very poor and the book lacks the images. Good for you because you can help us on that ;-)		We never found a PDF version of this book, just a very poor online HTML version. With the help of some scripts we assembled a standalone version of this book. Unfortunately the HTML syntax is very poor and the book lacks the images. Good for you because you can help us with that ;-)

	* Get the [http://svn.netlabs.org/v_doc/browser/CUA recent version] of this book in our Subversion		* Get the [http://svn.netlabs.org/v_doc/browser/CUA recent version] of this book in our Subversion
Line 56:		Line 56:
	* Start to clean it up. The syntax should look like in the beginning, very simple but clean XHTML code, as few <tt>br</tt> as possible, <tt>h1</tt>, <tt>h2</tt> for topic formating and <tt>p</tt> for paragraphs.		* Start to clean it up. The syntax should look like in the beginning, very simple but clean XHTML code, as few <tt>br</tt> as possible, <tt>h1</tt>, <tt>h2</tt> for topic formating and <tt>p</tt> for paragraphs.
	* Kill all table of contents and such things in the XHTML version. We will transform the XHTML to DocBook in a second step and DocBook will take care of that.		* Kill all table of contents and such things in the XHTML version. We will transform the XHTML to DocBook in a second step and DocBook will take care of that.
	* And if you are brave try to reproduce the images, at least those that make sense. This book is still available second hand, use that as a reference. ~~For sure it~~ would greatly help if someone finds a PDF version of the original document (in case that exists). It might get pretty tricky to reproduce some of the images because IBM created some sample applications for it, use what makes sense to you. For sure the images should be taken from a recent OS/2 or eCS system.		* And if you are brave enough to try to reproduce the images, at least those that make sense. This book is still available second hand, use that as a reference. It would greatly help us if someone finds a PDF version of the original document (in case that exists). It might get pretty tricky to reproduce some of the images because IBM created some sample applications for it, use what makes sense to you. For sure the images should be taken from a recent OS/2 or eCS system.