|
From: <qr...@us...> - 2006-11-27 21:39:47
|
Revision: 218
http://svn.sourceforge.net/opengate/?rev=218&view=rev
Author: qrstuvw
Date: 2006-11-27 13:39:48 -0800 (Mon, 27 Nov 2006)
Log Message:
-----------
Meta-server documentation by Ultrastick
Added Paths:
-----------
doc/meta_server/
doc/meta_server/login.odt
doc/meta_server/login.pdf
doc/meta_server/termless/
doc/meta_server/termless/version_info.odt
doc/meta_server/termless/version_info.pdf
Added: doc/meta_server/login.odt
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/login.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/login.pdf
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/login.pdf
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/termless/version_info.odt
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/termless/version_info.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/termless/version_info.pdf
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/termless/version_info.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.
|
|
From: <ult...@us...> - 2006-11-30 02:55:56
|
Revision: 236
http://svn.sourceforge.net/opengate/?rev=236&view=rev
Author: ultrasick
Date: 2006-11-29 18:55:56 -0800 (Wed, 29 Nov 2006)
Log Message:
-----------
uploaded some docus for the GUI
Added Paths:
-----------
doc/data/
doc/data/GUI/
doc/data/GUI/docked/
doc/data/GUI/docked/buttons.txt
doc/data/GUI/docked/caption.txt
doc/data/GUI/docked/green_backgrounds.txt
doc/data/GUI/docked/screws.txt
Added: doc/data/GUI/docked/buttons.txt
===================================================================
--- doc/data/GUI/docked/buttons.txt (rev 0)
+++ doc/data/GUI/docked/buttons.txt 2006-11-30 02:55:56 UTC (rev 236)
@@ -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: doc/data/GUI/docked/buttons.txt
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ native
Added: doc/data/GUI/docked/caption.txt
===================================================================
--- doc/data/GUI/docked/caption.txt (rev 0)
+++ doc/data/GUI/docked/caption.txt 2006-11-30 02:55:56 UTC (rev 236)
@@ -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: doc/data/GUI/docked/caption.txt
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ native
Added: doc/data/GUI/docked/green_backgrounds.txt
===================================================================
--- doc/data/GUI/docked/green_backgrounds.txt (rev 0)
+++ doc/data/GUI/docked/green_backgrounds.txt 2006-11-30 02:55:56 UTC (rev 236)
@@ -0,0 +1,9 @@
+BORDER
+------
+color: #88D997
+opacity: 1
+
+FILLING
+-------
+color: #36914B
+opacity: 0.5
\ No newline at end of file
Property changes on: doc/data/GUI/docked/green_backgrounds.txt
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ native
Added: doc/data/GUI/docked/screws.txt
===================================================================
--- doc/data/GUI/docked/screws.txt (rev 0)
+++ doc/data/GUI/docked/screws.txt 2006-11-30 02:55:56 UTC (rev 236)
@@ -0,0 +1 @@
+Auf 6 mm Bohrungen kommen 8 mm Schraubenk\xF6pfe
\ No newline at end of file
Property changes on: doc/data/GUI/docked/screws.txt
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ native
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ult...@us...> - 2007-09-28 10:47:07
|
Revision: 810
http://opengate.svn.sourceforge.net/opengate/?rev=810&view=rev
Author: ultrasick
Date: 2007-09-28 03:47:06 -0700 (Fri, 28 Sep 2007)
Log Message:
-----------
moving /trunk/doc to /doc (part 1 of 2)
Added Paths:
-----------
doc/
doc/Doxyfile
doc/Makefile.am
doc/blender-usage.txt
doc/coding-style.txt
doc/data/
doc/data/GUI/
doc/data/GUI/docked/
doc/data/GUI/docked/base/
doc/data/GUI/docked/base/cable.txt
doc/data/GUI/docked/base/market/
doc/data/GUI/docked/base/market/z-index_overview.odt
doc/data/GUI/docked/base/solid_parts.txt
doc/data/GUI/docked/base/surrounding/
doc/data/GUI/docked/base/surrounding/bottom/
doc/data/GUI/docked/base/surrounding/bottom/air_lock/
doc/data/GUI/docked/base/surrounding/bottom/air_lock/caption.txt
doc/data/GUI/docked/base/z-index_overview.odt
doc/data/GUI/docked/buttons.txt
doc/data/GUI/docked/caption.txt
doc/data/GUI/docked/green_backgrounds.txt
doc/data/GUI/docked/screws.txt
doc/data/sounds/
doc/data/sounds/sectors/
doc/data/sounds/sectors/quantar/
doc/data/sounds/sectors/quantar/Saros_-_Consolation_-_License_information.odt
doc/data/sounds/sectors/quantar/Saros_-_Consolation_-_License_information.pdf
doc/data/sounds/sectors/tauseti/
doc/data/sounds/sectors/tauseti/Simon_Mahler_-_HipDaHop_-_License_information.odt
doc/data/sounds/sectors/tauseti/Simon_Mahler_-_HipDaHop_-_License_information.pdf
doc/data/sounds/stations/
doc/data/sounds/stations/quantar/
doc/data/sounds/stations/quantar/Sarin_Sunday_-_Lonely_hike_-_License_information.odt
doc/data/sounds/stations/quantar/Sarin_Sunday_-_Lonely_hike_-_License_information.pdf
doc/meta_server/
doc/meta_server/client/
doc/meta_server/client/check_version.odt
doc/meta_server/client/check_version.pdf
doc/meta_server/client/login.odt
doc/meta_server/client/login.pdf
doc/meta_server/client/logout.odt
doc/meta_server/client/logout.pdf
doc/meta_server/game_server/
doc/meta_server/game_server/add_game_server.odt
doc/meta_server/game_server/add_game_server.pdf
doc/meta_server/game_server/list_game_servers.odt
doc/meta_server/game_server/list_game_servers.pdf
doc/meta_server/game_server/remove_game_server.odt
doc/meta_server/game_server/remove_game_server.pdf
doc/meta_server/global_error_code_overview.odt
doc/meta_server/global_error_code_overview.pdf
doc/network_model.odt
doc/network_model.pdf
Added: doc/Doxyfile
===================================================================
--- doc/Doxyfile (rev 0)
+++ doc/Doxyfile 2007-09-28 10:47:06 UTC (rev 810)
@@ -0,0 +1,277 @@
+# Doxyfile 1.5.2
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+DOXYFILE_ENCODING = UTF-8
+PROJECT_NAME = opengate
+PROJECT_NUMBER = 0.0.1
+OUTPUT_DIRECTORY = ./
+CREATE_SUBDIRS = NO
+OUTPUT_LANGUAGE = English
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = YES
+ABBREVIATE_BRIEF = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+ALWAYS_DETAILED_SEC = NO
+INLINE_INHERITED_MEMB = NO
+FULL_PATH_NAMES = YES
+STRIP_FROM_PATH =
+STRIP_FROM_INC_PATH =
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = NO
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP = NO
+INHERIT_DOCS = YES
+SEPARATE_MEMBER_PAGES = NO
+TAB_SIZE = 8
+ALIASES =
+OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_JAVA = NO
+BUILTIN_STL_SUPPORT = NO
+CPP_CLI_SUPPORT = NO
+DISTRIBUTE_GROUP_DOC = NO
+SUBGROUPING = YES
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = YES
+EXTRACT_PRIVATE = YES
+EXTRACT_STATIC = YES
+EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_METHODS = YES
+HIDE_UNDOC_MEMBERS = YES
+HIDE_UNDOC_CLASSES = YES
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = NO
+CASE_SENSE_NAMES = YES
+HIDE_SCOPE_NAMES = NO
+SHOW_INCLUDE_FILES = YES
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = YES
+SORT_BRIEF_DOCS = NO
+SORT_BY_SCOPE_NAME = NO
+GENERATE_TODOLIST = YES
+GENERATE_TESTLIST = YES
+GENERATE_BUGLIST = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 30
+SHOW_USED_FILES = YES
+SHOW_DIRECTORIES = NO
+FILE_VERSION_FILTER =
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = NO
+WARN_FORMAT = "$file:$line: $text"
+WARN_LOGFILE =
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = ../src/
+INPUT_ENCODING = UTF-8
+FILE_PATTERNS = *.c \
+ *.cc \
+ *.cxx \
+ *.cpp \
+ *.c++ \
+ *.d \
+ *.java \
+ *.ii \
+ *.ixx \
+ *.ipp \
+ *.i++ \
+ *.inl \
+ *.h \
+ *.hh \
+ *.hxx \
+ *.hpp \
+ *.h++ \
+ *.idl \
+ *.odl \
+ *.cs \
+ *.php \
+ *.php3 \
+ *.inc \
+ *.m \
+ *.mm \
+ *.dox \
+ *.py \
+ *.C \
+ *.CC \
+ *.C++ \
+ *.II \
+ *.I++ \
+ *.H \
+ *.HH \
+ *.H++ \
+ *.CS \
+ *.PHP \
+ *.PHP3 \
+ *.M \
+ *.MM \
+ *.PY
+RECURSIVE = YES
+EXCLUDE =
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS =
+EXCLUDE_SYMBOLS =
+EXAMPLE_PATH =
+EXAMPLE_PATTERNS = *
+EXAMPLE_RECURSIVE = NO
+IMAGE_PATH =
+INPUT_FILTER =
+FILTER_PATTERNS =
+FILTER_SOURCE_FILES = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = NO
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = YES
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION = NO
+REFERENCES_LINK_SOURCE = YES
+USE_HTAGS = NO
+VERBATIM_HEADERS = NO
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = NO
+COLS_IN_ALPHA_INDEX = 5
+IGNORE_PREFIX =
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = html
+HTML_FILE_EXTENSION = .html
+HTML_HEADER =
+HTML_FOOTER =
+HTML_STYLESHEET =
+HTML_ALIGN_MEMBERS = YES
+GENERATE_HTMLHELP = NO
+CHM_FILE =
+HHC_LOCATION =
+GENERATE_CHI = NO
+BINARY_TOC = NO
+TOC_EXPAND = NO
+DISABLE_INDEX = NO
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = NO
+TREEVIEW_WIDTH = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4wide
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = NO
+USE_PDFLATEX = NO
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = NO
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED =
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE =
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = YES
+PERL_PATH = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = YES
+MSCGEN_PATH =
+HIDE_UNDOC_RELATIONS = YES
+HAVE_DOT = YES
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = YES
+GROUP_GRAPHS = YES
+UML_LOOK = NO
+TEMPLATE_RELATIONS = NO
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = YES
+CALL_GRAPH = NO
+CALLER_GRAPH = NO
+GRAPHICAL_HIERARCHY = YES
+DIRECTORY_GRAPH = YES
+DOT_IMAGE_FORMAT = png
+DOT_PATH =
+DOTFILE_DIRS =
+DOT_GRAPH_MAX_NODES = 50
+DOT_TRANSPARENT = NO
+DOT_MULTI_TARGETS = NO
+GENERATE_LEGEND = YES
+DOT_CLEANUP = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+SEARCHENGINE = NO
Property changes on: doc/Doxyfile
___________________________________________________________________
Name: svn:eol-style
+ native
Added: doc/Makefile.am
===================================================================
--- doc/Makefile.am (rev 0)
+++ doc/Makefile.am 2007-09-28 10:47:06 UTC (rev 810)
@@ -0,0 +1,2 @@
+INCLUDES =
+METASOURCES = AUTO
Property changes on: doc/Makefile.am
___________________________________________________________________
Name: svn:eol-style
+ native
Added: doc/blender-usage.txt
===================================================================
--- doc/blender-usage.txt (rev 0)
+++ doc/blender-usage.txt 2007-09-28 10:47:06 UTC (rev 810)
@@ -0,0 +1,37 @@
+Opengate blender style
+----------------------
+
+Opengate uses Blender for several 3D models which will be transformed into
+images to be shown in the game. Since blender supports saving the workspace
+layout with the 3D model, opengate uses a common standard for how the default
+layout should look like.
+
+
+User Interface:
+The main window should be the 3D view (preferred in perspective and not
+orthogonal view). In the lower part normally object preferences or render
+should be shown. It is also ok to have the outline editor or the image editor
+in the right part of the main user interface.
+
+
+Rendering:
+The values for rendering shoud be "safe". This mean that the size of the
+rednered image should be below 1024x768 and the default setting should be
+to render it to the image window.
+
+File size:
+Models may not exceed the size of 500KB untextured and 4MB textured. Everything
+else cannot be accepted. It is also recommend to compress the file (Select
+"File"->"Compress File"), but the filesizes count for uncompressed files.
+
+Modifiers:
+Make use of blenders modifieres whereever possible or reasonable. Especially
+static subsurfing polygons is highly discouraged, it is much better to use the
+subsurface-modifierer. Also cloning objects should be done using the
+array-modifier (see the blender manual for details, especially the section
+about the "Empty"-object is pretty helpful).
+
+
+Please obey all these rules. If any files are found withing SVN that do not
+obey these rules, they will most likely be replaced or dropped if the heavily
+violate these rules.
Property changes on: doc/blender-usage.txt
___________________________________________________________________
Name: svn:eol-style
+ native
Added: doc/coding-style.txt
===================================================================
--- doc/coding-style.txt (rev 0)
+++ doc/coding-style.txt 2007-09-28 10:47:06 UTC (rev 810)
@@ -0,0 +1,116 @@
+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.) use tabs instead of spaces where usefull
+
+It's good style to use tabs for most indentions. Especially it is helpfull to
+use tabs at the beginning of each line. For example
+
+void main() {
+ return;
+}
+
+is a bad one, while this
+
+void main() {
+ return;
+}
+
+is a good one. You don't need to follow the rule preciseley, but that way
+everyone can indent the code as he likes. To don't mess up formatting we
+recommend to use spaces for indention that needs to be fixed. The example
+
+void main(int a, int b, int c, int d, int e,
+ int f, int g) {
+ return;
+}
+
+shows that the line "int f, ..." start with spaces. That way the command
+arguments are placed exactly where they are now. If you have a tab in front
+of you funtion, add the tab in the next line and then start with spaces.
+
+
+3.) 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.
+
+
+4.) 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
+
+5.) 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: doc/coding-style.txt
___________________________________________________________________
Name: svn:eol-style
+ native
Added: doc/data/GUI/docked/base/cable.txt
===================================================================
--- doc/data/GUI/docked/base/cable.txt (rev 0)
+++ doc/data/GUI/docked/base/cable.txt 2007-09-28 10:47:06 UTC (rev 810)
@@ -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: doc/data/GUI/docked/base/cable.txt
___________________________________________________________________
Name: svn:eol-style
+ native
Added: doc/data/GUI/docked/base/market/z-index_overview.odt
===================================================================
(Binary files differ)
Property changes on: doc/data/GUI/docked/base/market/z-index_overview.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/data/GUI/docked/base/solid_parts.txt
===================================================================
--- doc/data/GUI/docked/base/solid_parts.txt (rev 0)
+++ doc/data/GUI/docked/base/solid_parts.txt 2007-09-28 10:47:06 UTC (rev 810)
@@ -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: doc/data/GUI/docked/base/solid_parts.txt
___________________________________________________________________
Name: svn:eol-style
+ native
Added: doc/data/GUI/docked/base/surrounding/bottom/air_lock/caption.txt
===================================================================
--- doc/data/GUI/docked/base/surrounding/bottom/air_lock/caption.txt (rev 0)
+++ doc/data/GUI/docked/base/surrounding/bottom/air_lock/caption.txt 2007-09-28 10:47:06 UTC (rev 810)
@@ -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: doc/data/GUI/docked/base/surrounding/bottom/air_lock/caption.txt
___________________________________________________________________
Name: svn:eol-style
+ native
Added: doc/data/GUI/docked/base/z-index_overview.odt
===================================================================
(Binary files differ)
Property changes on: doc/data/GUI/docked/base/z-index_overview.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/data/GUI/docked/buttons.txt
===================================================================
--- doc/data/GUI/docked/buttons.txt (rev 0)
+++ doc/data/GUI/docked/buttons.txt 2007-09-28 10:47:06 UTC (rev 810)
@@ -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: doc/data/GUI/docked/buttons.txt
___________________________________________________________________
Name: svn:eol-style
+ native
Added: doc/data/GUI/docked/caption.txt
===================================================================
--- doc/data/GUI/docked/caption.txt (rev 0)
+++ doc/data/GUI/docked/caption.txt 2007-09-28 10:47:06 UTC (rev 810)
@@ -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: doc/data/GUI/docked/caption.txt
___________________________________________________________________
Name: svn:eol-style
+ native
Added: doc/data/GUI/docked/green_backgrounds.txt
===================================================================
--- doc/data/GUI/docked/green_backgrounds.txt (rev 0)
+++ doc/data/GUI/docked/green_backgrounds.txt 2007-09-28 10:47:06 UTC (rev 810)
@@ -0,0 +1,9 @@
+BORDER
+------
+color: #88D997
+opacity: 1
+
+FILLING
+-------
+color: #36914B
+opacity: 0.5
\ No newline at end of file
Property changes on: doc/data/GUI/docked/green_backgrounds.txt
___________________________________________________________________
Name: svn:eol-style
+ native
Added: doc/data/GUI/docked/screws.txt
===================================================================
--- doc/data/GUI/docked/screws.txt (rev 0)
+++ doc/data/GUI/docked/screws.txt 2007-09-28 10:47:06 UTC (rev 810)
@@ -0,0 +1 @@
+Auf 6 mm Bohrungen kommen 8 mm Schraubenk\xF6pfe
\ No newline at end of file
Property changes on: doc/data/GUI/docked/screws.txt
___________________________________________________________________
Name: svn:eol-style
+ native
Added: doc/data/sounds/sectors/quantar/Saros_-_Consolation_-_License_information.odt
===================================================================
(Binary files differ)
Property changes on: doc/data/sounds/sectors/quantar/Saros_-_Consolation_-_License_information.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/data/sounds/sectors/quantar/Saros_-_Consolation_-_License_information.pdf
===================================================================
(Binary files differ)
Property changes on: doc/data/sounds/sectors/quantar/Saros_-_Consolation_-_License_information.pdf
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/data/sounds/sectors/tauseti/Simon_Mahler_-_HipDaHop_-_License_information.odt
===================================================================
(Binary files differ)
Property changes on: doc/data/sounds/sectors/tauseti/Simon_Mahler_-_HipDaHop_-_License_information.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/data/sounds/sectors/tauseti/Simon_Mahler_-_HipDaHop_-_License_information.pdf
===================================================================
(Binary files differ)
Property changes on: doc/data/sounds/sectors/tauseti/Simon_Mahler_-_HipDaHop_-_License_information.pdf
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/data/sounds/stations/quantar/Sarin_Sunday_-_Lonely_hike_-_License_information.odt
===================================================================
(Binary files differ)
Property changes on: doc/data/sounds/stations/quantar/Sarin_Sunday_-_Lonely_hike_-_License_information.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/data/sounds/stations/quantar/Sarin_Sunday_-_Lonely_hike_-_License_information.pdf
===================================================================
(Binary files differ)
Property changes on: doc/data/sounds/stations/quantar/Sarin_Sunday_-_Lonely_hike_-_License_information.pdf
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/client/check_version.odt
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/client/check_version.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/client/check_version.pdf
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/client/check_version.pdf
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/client/login.odt
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/client/login.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/client/login.pdf
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/client/login.pdf
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/client/logout.odt
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/client/logout.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/client/logout.pdf
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/client/logout.pdf
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/game_server/add_game_server.odt
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/game_server/add_game_server.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/game_server/add_game_server.pdf
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/game_server/add_game_server.pdf
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/game_server/list_game_servers.odt
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/game_server/list_game_servers.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/game_server/list_game_servers.pdf
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/game_server/list_game_servers.pdf
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/game_server/remove_game_server.odt
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/game_server/remove_game_server.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/game_server/remove_game_server.pdf
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/game_server/remove_game_server.pdf
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/global_error_code_overview.odt
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/global_error_code_overview.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/meta_server/global_error_code_overview.pdf
===================================================================
(Binary files differ)
Property changes on: doc/meta_server/global_error_code_overview.pdf
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/network_model.odt
===================================================================
(Binary files differ)
Property changes on: doc/network_model.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: doc/network_model.pdf
===================================================================
(Binary files differ)
Property changes on: doc/network_model.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.
|