FreeOrion

Forums for the FreeOrion project
It is currently Mon Dec 18, 2017 6:32 pm

All times are UTC




Post new topic Reply to topic  [ 9 posts ] 
Author Message
PostPosted: Thu May 06, 2004 11:04 am 
Offline
FreeOrion Lead Emeritus
User avatar

Joined: Thu Jun 26, 2003 6:23 am
Posts: 885
Location: Australia
I have set up a wiki to enable us to easily write and maintain documentation for FreeOrion.

Pages can be added and edited by any members of the public. It includes revision control to revert to previous versions if vandals change anything. It also include IP banning. If it gets out of control, we can limit modifications to members. Certain pages can also be blocked.

The link for "knowledge base" has been changed to "FreeOrionWiki" on the main page, which points to:
http://www.freeorion.org/wiki/index.php

You can find resources on how to modify the wiki and add pages here:
http://meta.wikipedia.org/wiki/MediaWik ... g_overview

Feel free to modify and add articles. Once the main page is designed neatly and ready I'll lock it so only admin can modify it. Most other pages will be open to the public. I'll be watching and making sure the content is organised weakly. Where possible use precedences set by wikipedia.


Top
 Profile  
 
 Post subject:
PostPosted: Thu May 06, 2004 11:45 am 
Offline
FreeOrion Lead Emeritus
User avatar

Joined: Thu Jun 26, 2003 6:23 am
Posts: 885
Location: Australia
Here is a list of things that would be useful to write. Remember that anyone can modify your work, so mistakes will be fixed, more can be added and removed later, etc.

* FAQ
* Specifications for 0.1 and 0.2, converted from the documents into the wiki code, using tables, etc, where appropriate.
* Roadmap
* Forums guide
* Introduction to the project and community
* Details on the system
* How to contribute, areas to help, etc
* Rules! (eg, no realism arguments, respect other people, no politics of recent times, no religious arguments
* Manual/instructions for installing and playing 0.1 - including the core issues. Not really important, but will certainly be useful for versions past 0.1

If you have any other ideas or want to suggest something you are considering writing, place it in this thread.


Top
 Profile  
 
 Post subject:
PostPosted: Thu May 06, 2004 2:16 pm 
Offline
Space Squid
User avatar

Joined: Thu Feb 19, 2004 10:26 am
Posts: 65
Location: Nijmegen (NL)
Will this also be for source documentation? I guess "details on the system" could include that. I do not mean per-function documentation (that's what doxygen is for), but a description of and comments on the general structure of the program.

edit: I like it! I added some rather nonessential pages, but only because I have been out of the running for a while and do now know all the important stuff for sure. I'll be contributing more once I get the game to compile on my FreeBSD system so that I can actually check things.


Top
 Profile  
 
 Post subject:
PostPosted: Thu May 06, 2004 8:58 pm 
Offline
FreeOrion Lead Emeritus
User avatar

Joined: Thu Jun 26, 2003 6:23 am
Posts: 885
Location: Australia
For source documentation we'd be much better off running doxygen and uploading the documentation it creates on a separate page. Much more efficient, quicker and more accurate :wink:


Top
 Profile  
 
 Post subject:
PostPosted: Tue Jun 15, 2004 9:06 pm 
Offline
Programming, Design, Admin
User avatar

Joined: Wed Oct 08, 2003 1:33 am
Posts: 12046
Location: Munich
Is it appropriate to post summaries of passed design features, or entire Aquatine posts at the ends of public reviews into the wiki? I'm talking about things decided for inclusion (however vaguely) in ver. 1.0, not the next ver. 0.X.

A centralized place to find all passed features and decided details without searching through heaps of posts and threads would be good.

If this is a good idea, could a wiki admin make some links from the front page? I can't make a new page without a link, and can't find a good place to put such a link that's not locked. (I could put links from waaaay down on the Game Design page, but something obviously visible without hunting / scrolling would be good)


Top
 Profile  
 
 Post subject:
PostPosted: Wed Jun 16, 2004 2:32 pm 
Offline
Lead Designer Emeritus
User avatar

Joined: Thu Jun 26, 2003 1:54 pm
Posts: 761
Location: Austin, TX
This sounds like a good idea. I'll see about making sure that final posts/summaries of the public reviews end up in the Wiki. The result should be a sort of 'design document broken down by subject' since those final posts are usually the predecessor to the design doc entries on the subject.

_________________
Surprise and Terror! I am greeted by the smooth and hostile face of our old enemy, the Hootmans! No... the Huge-glands, no, I remember, the Hunams!


Top
 Profile  
 
 Post subject:
PostPosted: Thu Jun 17, 2004 6:32 am 
Offline
Programming, Design, Admin
User avatar

Joined: Wed Oct 08, 2003 1:33 am
Posts: 12046
Location: Munich
Is the current design document available in the wiki right now? I've seen posts that claim it is, but I can't find it by searching or hunting for links... and nobody seem to be linking to it spontaneously or able to provide a link if I ask for one...

If not, could you put it up, and add a clear link on the main page, asap? (Edit: main page of the wiki )

Thanks.


Top
 Profile  
 
 Post subject:
PostPosted: Thu Jun 17, 2004 7:30 am 
Offline
Space Kraken

Joined: Tue May 25, 2004 3:15 am
Posts: 157
Watch these pages to track changes:
http://www.freeorion.org/wiki/index.php ... entchanges
and
http://www.freeorion.org/wiki/index.php ... l:Newpages

Design related, right now I think there is only V.2 Requirements and Effects. More static (done) design pages: Vision Statement, V.1 Requirements and Roadmap. There is nothing extensively detailing the passed features.


Top
 Profile  
 
 Post subject:
PostPosted: Thu Jun 17, 2004 11:59 am 
Offline
Designer Emeritus

Joined: Thu Jun 26, 2003 8:07 am
Posts: 935
Effects is unofficial. v.2 is "static", ie done.


Top
 Profile  
 
Display posts from previous:  Sort by  
Post new topic Reply to topic  [ 9 posts ] 

All times are UTC


Who is online

Users browsing this forum: No registered users and 1 guest


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
Powered by phpBB® Forum Software © phpBB Group