[Opengate-svn] SF.net SVN: opengate: [266] trunk

[<qr...@us...>]

Revision: 266
          http://svn.sourceforge.net/opengate/?rev=266&view=rev
Author:   qrstuvw
Date:     2006-12-09 10:39:13 -0800 (Sat, 09 Dec 2006)

Log Message:
-----------
Moved doc from revision 262 to new directories

Revision Links:
--------------
    http://svn.sourceforge.net/opengate/?rev=262&view=rev

Added Paths:
-----------
    trunk/doc/
    trunk/doc/Makefile.am
    trunk/doc/coding-style.txt
    trunk/doc/data/
    trunk/doc/data/GUI/
    trunk/doc/data/GUI/docked/
    trunk/doc/data/GUI/docked/base/
    trunk/doc/data/GUI/docked/base/cable.txt
    trunk/doc/data/GUI/docked/base/market/
    trunk/doc/data/GUI/docked/base/market/z-index_overview.odt
    trunk/doc/data/GUI/docked/base/solid_parts.txt
    trunk/doc/data/GUI/docked/base/surrounding/
    trunk/doc/data/GUI/docked/base/surrounding/bottom/
    trunk/doc/data/GUI/docked/base/surrounding/bottom/air_lock/
    trunk/doc/data/GUI/docked/base/surrounding/bottom/air_lock/caption.txt
    trunk/doc/data/GUI/docked/base/z-index_overview.odt
    trunk/doc/data/GUI/docked/buttons.txt
    trunk/doc/data/GUI/docked/caption.txt
    trunk/doc/data/GUI/docked/green_backgrounds.txt
    trunk/doc/data/GUI/docked/screws.txt
    trunk/doc/meta_server/
    trunk/doc/meta_server/check_version.odt
    trunk/doc/meta_server/check_version.pdf
    trunk/doc/meta_server/global_error_code_overview.odt
    trunk/doc/meta_server/global_error_code_overview.pdf
    trunk/doc/meta_server/login.odt
    trunk/doc/meta_server/login.pdf
    trunk/doc/meta_server/logout.odt
    trunk/doc/meta_server/logout.pdf

Added: trunk/doc/Makefile.am
===================================================================
--- trunk/doc/Makefile.am	                        (rev 0)
+++ trunk/doc/Makefile.am	2006-12-09 18:39:13 UTC (rev 266)
@@ -0,0 +1,2 @@
+INCLUDES = 
+METASOURCES = AUTO


Property changes on: trunk/doc/Makefile.am
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Added: trunk/doc/coding-style.txt
===================================================================
--- trunk/doc/coding-style.txt	                        (rev 0)
+++ trunk/doc/coding-style.txt	2006-12-09 18:39:13 UTC (rev 266)
@@ -0,0 +1,88 @@
+Opengate coding style
+---------------------
+
+Opengate uses a common C++ coding style which will be described in this short
+document. It is highly recommend to obey this style to keep the sourcecode
+clean and the project up and running. There are few golden rules that I will
+tell first:
+
+1.) alwayse use braces
+
+Lets take a BAD examlpe:
+
+	i = 0;
+	if (false)
+		i++;
+		i += 2;
+	std::cout << i << std::endl;
+
+You see the the problem? Good. The "i += 2" call is always called but it looks
+like it will only be called on the if-case. The corrected version:
+
+	i = 0;
+	if (false) {
+		i++;
+	}
+	i += 2;
+	std::cout << i << std::endl;
+
+This is way better. So: always use braces to show where a block of code begins
+and where it ends.
+
+
+2.) document the tricky parts
+
+I'll be reviewing the code that will be added to the repository. If it does
+something tricky, comment on it. Tell why you have done it this way. Tell how
+it works in a few sentences. I'll not tolerate code that is doing "magic". I
+want to know how and why it works. If I can't understand it, it won't end in
+the game... unless it is documented.
+
+
+3.) use doxygen
+
+I recommend documenting the source using doxygen. I know, it's bloating the
+code and might even be annoying, but: It will help others, like me :-) So I
+really recommend these 2 websites of the doxygen manual. The first is a short
+overview the syntax [1], the second is a list of all available commands [2].
+
+[1] http://www.stack.nl/~dimitri/doxygen/docblocks.html
+[2] http://www.stack.nl/~dimitri/doxygen/commands.html
+
+4.) code example
+
+class Test {
+public:
+	Test();
+	~Test();
+private:
+	int test;
+}
+
+Test::Test() {
+	if (1 == 2) {
+		int i = 2;
+	} else {
+		int j = 1;
+	}
+	int k = 3;
+	switch (k) {
+	case 1:
+		break;
+	case 2:
+	case 3:
+		break;
+	default:
+		break;
+	}
+}
+
+Test::~Test() {
+	std::cout << "end" << std::endl;
+}
+
+I hope this example shows how the sourcecode should look like. If there are
+any questions, look at the give code or ask on the mailing lists for help.
+
+That's it. Please follow these guidelines to help opengate getting forward.
+Thanks for reading, happy programming ;-)


Property changes on: trunk/doc/coding-style.txt
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Added: trunk/doc/data/GUI/docked/base/cable.txt
===================================================================
--- trunk/doc/data/GUI/docked/base/cable.txt	                        (rev 0)
+++ trunk/doc/data/GUI/docked/base/cable.txt	2006-12-09 18:39:13 UTC (rev 266)
@@ -0,0 +1,27 @@
+KORDEL:
+	Ma\xDFstab: 20
+	Schrittgr\xF6\xDFe: 1
+	Platzierungsmodus: Gleichm\xE4\xDFig
+	Auswahlmodus: Schrittweise
+
+	Kordel von oben und von rechts ziehen damit beleuchtung stimmt
+
+FARBTON/S\xC4TTIGUNG/HELLIGKEIT ANPASSEN:
+	Bearbeiten: alle farben
+	Kolorieren: nein
+	Farbton: +180
+	S\xE4ttigung: -15
+	Helligkeit: -15
+
+Anschlussbohrungen:
+	Durchmesser: 4 mm
+	AU\xDFENFASE:
+		Breite:		  2
+		Schliff:	  2
+		Tiefe:		  2
+		Umgebung:	  5
+		Reflexion:	 30
+		Winkel:		315
+		Intensit\xE4t:	 48
+		H\xF6he:		 30
+		Farbe:		#FFFFFF
\ No newline at end of file


Property changes on: trunk/doc/data/GUI/docked/base/cable.txt
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Added: trunk/doc/data/GUI/docked/base/market/z-index_overview.odt
===================================================================
(Binary files differ)


Property changes on: trunk/doc/data/GUI/docked/base/market/z-index_overview.odt
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/doc/data/GUI/docked/base/solid_parts.txt
===================================================================
--- trunk/doc/data/GUI/docked/base/solid_parts.txt	                        (rev 0)
+++ trunk/doc/data/GUI/docked/base/solid_parts.txt	2006-12-09 18:39:13 UTC (rev 266)
@@ -0,0 +1,11 @@
+INNENFASE
+
+Breite:		  5
+Schliff:	  5
+Tiefe:		  5
+Umgebung:	  5
+Reflexion:	 30
+Winkel:		315
+Intensit\xE4t:	 48
+H\xF6he:		 30
+Farbe:		#FFFFFF
\ No newline at end of file


Property changes on: trunk/doc/data/GUI/docked/base/solid_parts.txt
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Added: trunk/doc/data/GUI/docked/base/surrounding/bottom/air_lock/caption.txt
===================================================================
--- trunk/doc/data/GUI/docked/base/surrounding/bottom/air_lock/caption.txt	                        (rev 0)
+++ trunk/doc/data/GUI/docked/base/surrounding/bottom/air_lock/caption.txt	2006-12-09 18:39:13 UTC (rev 266)
@@ -0,0 +1,14 @@
+Schriftart: Arial Black
+Schriftgrad: 10
+Strichst\xE4rke: 0,2 Pixel
+
+Schriftfarbe - F\xFCllung: #000000
+Schriftfarbe - Umrandung: #FFFF00
+
+Antialiasing:	ja
+Fett:		nein
+Kursiv:		nein
+Unterstrichen:	nein
+
+Kerning:	-100
+Zeilenabstand:	0
\ No newline at end of file


Property changes on: trunk/doc/data/GUI/docked/base/surrounding/bottom/air_lock/caption.txt
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Added: trunk/doc/data/GUI/docked/base/z-index_overview.odt
===================================================================
(Binary files differ)


Property changes on: trunk/doc/data/GUI/docked/base/z-index_overview.odt
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/doc/data/GUI/docked/buttons.txt
===================================================================
--- trunk/doc/data/GUI/docked/buttons.txt	                        (rev 0)
+++ trunk/doc/data/GUI/docked/buttons.txt	2006-12-09 18:39:13 UTC (rev 266)
@@ -0,0 +1,49 @@
+YELLOW BUTTONS
+==============
+
+	BORDER
+	------
+		opacity: 1
+
+		MOUSEOUT
+		- - - -
+			color: #88D997
+
+		MOUSEDOWN
+		- - - - -
+			color: #FFFD63
+
+	FILLING (MOUSEOVER)
+	-------------------
+	color: #88D997
+	opacity: 0.5
+
+BLUE BUTTONS
+============
+
+	BORDER
+	------
+		opacity: 1
+
+		MOUSEOUT
+		- - - -
+			color: #0096FF
+
+		MOUSEDOWN
+		- - - - -
+			color: #BAEAC3
+
+	FILLING
+	-------------------
+	color: #376C91
+	opacity: 0.5
+
+	FONT/CONTENT
+	------------
+		MOUSEOUT
+		- - - -
+			color: #0096FF
+
+		MOUSEOVER AND MOUSEDOWN
+		- - - - - - - - - - - -
+			color: #BAEAC3
\ No newline at end of file


Property changes on: trunk/doc/data/GUI/docked/buttons.txt
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Added: trunk/doc/data/GUI/docked/caption.txt
===================================================================
--- trunk/doc/data/GUI/docked/caption.txt	                        (rev 0)
+++ trunk/doc/data/GUI/docked/caption.txt	2006-12-09 18:39:13 UTC (rev 266)
@@ -0,0 +1,111 @@
+------------------------------------------------------------------
+Global screen - 5 points menu
+------------------------------------------------------------------
+
+font-family:	Impact
+font-size:	10pt(pt?)
+
+font-color - normal: #36914B
+font-color - selected: #88D997
+
+Antialiasing:	ja
+Fett:		nein
+Kursiv:		nein
+Unterstrichen:	nein
+
+Gehrungsgrenze:	10
+Kerning:	-20
+Zeilenabstand:	0
+
+------------------------------------------------------------------
+Market screen - Embracing borders (for Example "Public market")
+------------------------------------------------------------------
+
+font-family:	Impact
+font-size:	10pt
+font-color:	#88D997
+
+Antialiasing:	ja
+Fett:		nein
+Kursiv:		nein
+Unterstrichen:	nein
+
+Gehrungsgrenze:	10
+Kerning:	0
+Zeilenabstand:	0
+
+------------------------------------------------------------------
+Market screen - Categories
+------------------------------------------------------------------
+
+font-family:	Impact
+font-size:	12pt
+
+font-color - normal: #88D997
+font-color - selected: #BAEAC3
+
+Antialiasing:	ja
+Fett:		nein
+Kursiv:		nein
+Unterstrichen:	nein
+
+Gehrungsgrenze:	10
+Kerning:	0
+Zeilenabstand:	0
+
+------------------------------------------------------------------
+Market screen - Buttons (for Example "show all", "sort ascending")
+------------------------------------------------------------------
+
+font-family:	Impact
+font-size:	9pt
+
+OFF:
+	font-color - mouseout: #88D997
+	font-color - mouseover: #BAEAC3
+ON:
+	font-color - mouseout: #BAEAC3
+	font-color - mouseover: #0096FF
+
+Antialiasing:	ja
+Fett:		nein
+Kursiv:		nein
+Unterstrichen:	nein
+
+Gehrungsgrenze:	10
+Kerning:	0
+Zeilenabstand:	0
+
+------------------------------------------------------------------
+Market screen - Items - Price
+------------------------------------------------------------------
+
+font-family:	Lucida Console
+font-size:	8pt
+font-color:	black
+
+Antialiasing:	ja
+Fett:		nein
+Kursiv:		nein
+Unterstrichen:	nein
+
+Gehrungsgrenze:	10
+Kerning:	0
+Zeilenabstand:	0
+
+------------------------------------------------------------------
+Market screen - Items - Object name and quantity available
+------------------------------------------------------------------
+
+font-family:	Lucida Console
+font-size:	7pt
+font-color:	#88D997
+
+Antialiasing:	ja
+Fett:		nein
+Kursiv:		nein
+Unterstrichen:	nein
+
+Gehrungsgrenze:	10
+Kerning:	0
+Zeilenabstand:	0
\ No newline at end of file


Property changes on: trunk/doc/data/GUI/docked/caption.txt
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Added: trunk/doc/data/GUI/docked/green_backgrounds.txt
===================================================================
--- trunk/doc/data/GUI/docked/green_backgrounds.txt	                        (rev 0)
+++ trunk/doc/data/GUI/docked/green_backgrounds.txt	2006-12-09 18:39:13 UTC (rev 266)
@@ -0,0 +1,9 @@
+BORDER
+------
+color: #88D997
+opacity: 1
+
+FILLING
+-------
+color: #36914B
+opacity: 0.5
\ No newline at end of file


Property changes on: trunk/doc/data/GUI/docked/green_backgrounds.txt
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Added: trunk/doc/data/GUI/docked/screws.txt
===================================================================
--- trunk/doc/data/GUI/docked/screws.txt	                        (rev 0)
+++ trunk/doc/data/GUI/docked/screws.txt	2006-12-09 18:39:13 UTC (rev 266)
@@ -0,0 +1 @@
+Auf 6 mm Bohrungen kommen 8 mm Schraubenk\xF6pfe
\ No newline at end of file


Property changes on: trunk/doc/data/GUI/docked/screws.txt
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Added: trunk/doc/meta_server/check_version.odt
===================================================================
(Binary files differ)


Property changes on: trunk/doc/meta_server/check_version.odt
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/doc/meta_server/check_version.pdf
===================================================================
(Binary files differ)


Property changes on: trunk/doc/meta_server/check_version.pdf
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/doc/meta_server/global_error_code_overview.odt
===================================================================
(Binary files differ)


Property changes on: trunk/doc/meta_server/global_error_code_overview.odt
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/doc/meta_server/global_error_code_overview.pdf
===================================================================
(Binary files differ)


Property changes on: trunk/doc/meta_server/global_error_code_overview.pdf
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/doc/meta_server/login.odt
===================================================================
(Binary files differ)


Property changes on: trunk/doc/meta_server/login.odt
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/doc/meta_server/login.pdf
===================================================================
(Binary files differ)


Property changes on: trunk/doc/meta_server/login.pdf
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/doc/meta_server/logout.odt
===================================================================
(Binary files differ)


Property changes on: trunk/doc/meta_server/logout.odt
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Added: trunk/doc/meta_server/logout.pdf
===================================================================
(Binary files differ)


Property changes on: trunk/doc/meta_server/logout.pdf
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream


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