Sorry your browser is not supported!

You are using an outdated browser that does not support modern web technologies, in order to use this site please update to a new browser.

Browsers supported include Chrome, FireFox, Safari, Opera, Internet Explorer 10+ or Microsoft Edge.

Geek Culture / Official TGC Wiki

Author
Message
Daniel TGC
Retired Moderator
17
Years of Service
User Offline
Joined: 19th Feb 2007
Location: TGC
Posted: 28th Aug 2007 17:02 Edited at: 28th Aug 2007 17:03
Hi, in an effort to improve existing documentation, and provide a central source of information for our products, the company is now in the process of developing a new Wiki system. As with any Wiki, customers and TGC personnel alike will be able to update, and improve upon existing product information. For now I am in the process of converting our existing documentation onto the new system. Obviously given that HTML needs to be converted into Wiki's own language, this will be a long tedious task, so I can't promise any kind of official release date right now. It is our hope that the upcoming Wiki will also provide a chance for us to update our off-line documentation as well. Thus helping everyone to develop their own software and products even more effectively then before.

Below is an image of the propose command help layout using one of DarkBASIC Professionals commands. I'd like to hear your thoughts on it, and any suggestions for additions and/ or improvements. By adding the colour scheme to the commands, it should help user's more easily distinguish between string and numerical values, as well as the commands themselves. With the further adding of a parameters section, more information on the specific nature of the parameters can be explained, without simply lumping it in with the main body of text. Anyway let me know what you think. It's better to get the style set now, I'd hate to rush forward and end up having to rewrite the whole site!

Thanks in advance!

Daniel Foreman.



Attachments

Login to view attachments
Digital Awakening
AGK Developer
22
Years of Service
User Offline
Joined: 27th Aug 2002
Location: Sweden
Posted: 28th Aug 2007 17:05 Edited at: 28th Aug 2007 17:07
John Y was in the process of updating the help files on the DBP board. link I think his layout looks good.

Will you be using the Wikipedia wiki system?

[center]
CREATE games with ease! NO programming required!
WIP
Daniel TGC
Retired Moderator
17
Years of Service
User Offline
Joined: 19th Feb 2007
Location: TGC
Posted: 28th Aug 2007 17:09
We're experimenting with media wiki at the moment yes.

Nicholas Thompson
20
Years of Service
User Offline
Joined: 6th Sep 2004
Location: Bognor Regis, UK
Posted: 28th Aug 2007 17:13 Edited at: 28th Aug 2007 17:15
Personal preference - but I quite like the Drupal Wiki Installation Profile. I've tried Media Wiki and found it quite "clunky"...

We use the Drupal one at work for an internal "knowledge base" and it works pretty well. It supports...

* Editing for anonymous users
* Moderator role which can revert / delete pages
* Revisions for pages
* Mediawiki input format + Image assist
* Categorization via free tagging vocabulary
* Views: All pages / All categories / All Images
* Recent changes

Now I know that MediaWiki can do all of those and more - but my personal problem with MediaWiki is that it seemed to have no desire to be anything other than a Wiki which SEVERELY limits its future as a platform.

btw, you can also install the BBCode Module which makes the Wiki setup even better (automatic hyperlinking of urls and email addresses, etc). There are also modules for obfuscating email addresses, ones for controlling the content of the meta tags and page titles (<title> in the head rather than the <h1> title) to improve usability in search engines and many more. There are also translation layers in Drupal too which I've yet to explore.

[center]
Chris K
21
Years of Service
User Offline
Joined: 7th Oct 2003
Location: Lake Hylia
Posted: 28th Aug 2007 21:12
Where did you get this idea from...

This is awesome I was hoping it would be official.

Can we do something about images that are too wide for 1024x768? That has always annoyed me intenstely...

-= Out here in the fields, I fight for my meals =-
LD52
18
Years of Service
User Offline
Joined: 31st Aug 2006
Location: Internet
Posted: 29th Aug 2007 09:26
Awesome job! Can't wait.
Jess T
Retired Moderator
21
Years of Service
User Offline
Joined: 20th Sep 2003
Location: Over There... Kablam!
Posted: 29th Aug 2007 11:07 Edited at: 29th Aug 2007 11:08
Daniel, when I first set up dbHelp all those years ago, to get all the information out of the help files and into my MySQL database, I wrote a very, very simple parser.
Took two afternoons, and by the time I was finished, I let it loose on the Help file directory which eventually spat everything out in the exact format that I needed it in. Worked like a charm.

I've attached the DBP project I created to do it.

Seriously, write a tool once, takes you about 4 hours, then it's done for ever.

[EDIT]
I should point out that this is possible because of the format of the HTML in the current helpfiles. It's identical for every single file, except, of course, the content.
[/EDIT]

Nintendo DS & Dominos :: DS Dominos
http://jt0.org

Attachments

Login to view attachments
Nicholas Thompson
20
Years of Service
User Offline
Joined: 6th Sep 2004
Location: Bognor Regis, UK
Posted: 29th Aug 2007 15:07
Scripts Rule - I tend to use a similar process when I need to import data, except I have a tendancy towards a PHP shell script + a shed load of Regular Expression...

[center]
Daniel TGC
Retired Moderator
17
Years of Service
User Offline
Joined: 19th Feb 2007
Location: TGC
Posted: 29th Aug 2007 18:49
Thanks for that. I'm sure it will be very useful.

Agent Dink
20
Years of Service
User Offline
Joined: 30th Mar 2004
Location:
Posted: 30th Aug 2007 07:13
Sounds awesome Lookin' forward to it. Perhaps a few tables might spruce things up a bit on the wiki entries. Around code it may be nice to have a box slightly indented from the normal type, and within that box have the code snippets.

Jess T
Retired Moderator
21
Years of Service
User Offline
Joined: 20th Sep 2003
Location: Over There... Kablam!
Posted: 31st Aug 2007 09:05
Nick,

When I wrote that, I don't think I knew the first thing about regex's! I did know that I already had a little string library written up in DBP, though, which let me quickly and easily get at what I wanted, so I just threw it together

Daniel,

No worries, mate.

Dink,

Urg, no tables!
I'm sure the Wiki system will have some templates set out somewhere that lets code be different without the need for tables.

Nintendo DS & Dominos :: DS Dominos
http://jt0.org
TinTin
18
Years of Service
User Offline
Joined: 16th May 2006
Location: BORG Drone Ship - Being Assimilated near Roda Beta (28)
Posted: 12th Sep 2007 16:24
Looking forward to whatever Help system gets finished first.
The current one's driving me nuts.

Cyberspace was becoming overcrowded and slummy so I decided to move. These nice chaps gave me a lift.
APEXnow
Retired Moderator
21
Years of Service
User Offline
Joined: 15th Apr 2003
Location: On a park bench
Posted: 13th Sep 2007 03:16
This is purely under construction and may go through a complete rewrite when more documentation and trusted users are available, but I did make a Wiki for DGDK.NET quite a while back. Still available ironically: http://darkgdk.pbwiki.com:80/

Anyway, my point is this... if the documentation is made available for updating to trusted individuals, could this help in the progression of both DGDK.NET and all other TGC products?

I'm interested for sure

Paul.

Omen
18
Years of Service
User Offline
Joined: 7th Nov 2006
Location: Maple Grove, MN US
Posted: 18th Nov 2007 05:03
@Daniel,

I'd be interested in helping out with the Wiki! I hope this will be an integral part of the TGC website - I'd love to see this as the #1 link under the support button on the DarkBasic Professional homepage - a big "Documentation" link right before "Upgrades"
Dewi Morgan
16
Years of Service
User Offline
Joined: 16th Jan 2008
Location: London, UK
Posted: 11th Mar 2008 15:23 Edited at: 11th Mar 2008 15:54
Is there a link to the DBP wiki-in-development? I'd be interested in helping with it, or if the project is dead, making and hosting my own.

At the moment, anyone undertaking a reasonable sized project needs to spend a few days gathering and formatting documentation for ease of reference. Having done this work, I'm irked that other people will have to redo it: having a way to publicly share doc improvements and changes would be good, and a wiki system seems the obvious way.

Would the wiki only document core DBP? Way I see it, no reference will be a "full reference" if it doesn't include third party addons.

Also, the wiki would ideally be exportable to .chm and other formats, to avoid the current problem of multiple different documentation "streams".

[Edit: Also if the wiki could import functions and commands from POD or whatever inline doc syntax you use, that would be cool too.]

[Edit2: guessed it: wiki.thegamecreators.com ]

[Edit 3:
Since the wiki exists but appears to be dead, and almost completely bare, would anyone be really upset if I created pages for the documented core commands, from the existing documentation, since they don't seem to be there already?

What if I also included lists of commands (without documentation) for all known third party plugin DLLs? Simple lists are not subject to copyright, but command documentation usually will be, so insertion of full documentation would require either rewriting, or plugin author permission.
]

Yet another programmer - http://www.thudgame.com/mmo
All my posts are Public Domain unless I say otherwise.
You may use all my code and ideas as you see fit.
Roxas
19
Years of Service
User Offline
Joined: 11th Nov 2005
Location: http://forum.thegamecreators.com
Posted: 11th Mar 2008 22:59
Did this wiki go anywhere?

If anyone wants that i have no comerical host i can put my old wiki up wich had pretty much of an entries

Tho well i dont have the old one anymore but i can make new on time.


Click For Details!
El Goorf
18
Years of Service
User Offline
Joined: 17th Sep 2006
Location: Uni: Manchester, Home: Dunstable
Posted: 13th Mar 2008 12:28
i was told it was stopped since they dont have the manpower, which i dont understand, since im sure much of the community would be willing to help

http://notmybase.com
All my base are not belong to anyone.
Jeku
Moderator
21
Years of Service
User Offline
Joined: 4th Jul 2003
Location: Vancouver, British Columbia, Canada
Posted: 14th Mar 2008 02:12
Yah, I had a DBP wiki up for a while too but when this "Official" one came along, I pulled it from the server.


BatVink
Moderator
21
Years of Service
User Offline
Joined: 4th Apr 2003
Location: Gods own County, UK
Posted: 14th Mar 2008 11:47
I think it would be good to open up to anyone willing to assist. Maybe the pre-requiste for getting access would be to provide evidence of the documentation you have prepared. Then you and the info are sense-checked prior to it being added.

As mentioned in the other thread in DBP, having index pages would be good, as Wikis don't lend themselves to organised lists. Not sure how you would approach the task of marking articles with the Plugin / version information. This should be mandatory and highlighted at the top of every article. Icons would be nice

Never having added to a Wiki, I don't know if creating links is a manual task. Every code snippet and example should link the commands in it to their respective page.

So maybe there is some preparatory work to be done to make this happen. Or maybe Nicholas' solution is better suited, and should be adopted as an official tool if it comes to fruition.
snuffy
17
Years of Service
User Offline
Joined: 10th Jun 2007
Location: Snoqualmie
Posted: 15th Mar 2008 08:08
I would like to see a little more information about common errors generated by the commands as well or a reference too them. Also many of the commands have extra parameters like if you add a ",0" or ",1" etc that change the way the command performs. And some commands return values like "Make Vector3". What do the returns mean? Some of these are simple like 0=failure and 1=success. An interesting one is "camera angle x()", I thought this command was going to give me the angle like if I did an xrotate camera but instead gives me euler angles instead. A good wiki would reference euler angles especially as they pertain to DBPro. The hands on books are ok for looking at the basic commands but leave alot unsaid. Any how I think this is a great idea and I hope it succeeds.
bitJericho
22
Years of Service
User Offline
Joined: 9th Oct 2002
Location: United States
Posted: 31st Mar 2008 01:20
Quote: "Maybe the pre-requiste for getting access would be to provide evidence of the documentation you have prepared. Then you and the info are sense-checked prior to it being added."


That defeats the point of a wiki. I say set up a few base pages and let it become available.


Hurray for teh logd!
Nicholas Thompson
20
Years of Service
User Offline
Joined: 6th Sep 2004
Location: Bognor Regis, UK
Posted: 12th Apr 2008 19:03
As much as I agree that it defeats the point in the Wiki, Jerico2day, what do you think will happen to a Wiki project if some people start posting crap into it? By crap - let me define myself - broken code, duplicate code, support questions, irrelevant code, etc...

How annoyed would you be if you went to the Wiki and it told you a certain feature existed, you then spend 4 hours of your life trying to figure out why its not working as expected only to find out that "Joe Moron" decided to post it and there was no moderation procedure.

Personally - I think the "best" way is kind of how these forums work. ANYONE can signup and post/edit - however only people who are 'trusted' get the privilege of posting without moderation (eg, the n00b slap).
The disadvantage of this is the required man-power.

[center]
bitJericho
22
Years of Service
User Offline
Joined: 9th Oct 2002
Location: United States
Posted: 13th Apr 2008 03:18
Quote: "As much as I agree that it defeats the point in the Wiki, Jerico2day, what do you think will happen to a Wiki project if some people start posting crap into it? By crap - let me define myself - broken code, duplicate code, support questions, irrelevant code, etc..."


First off, that's what you have mods for. Second off, it just won't happen as often as you fear. You'll have abusers, sure, but you'll have mods to ban them.

Quote: "The disadvantage of this is the required man-power."


My point exactly. Instead of having a bunch of people moderating every new post, how about having a bunch of people *post something to begin with*!


Hurray for teh logd!
El Goorf
18
Years of Service
User Offline
Joined: 17th Sep 2006
Location: Uni: Manchester, Home: Dunstable
Posted: 13th Apr 2008 13:47
*sides with jerico2day's arguments*

having the wiki would offload a lot of work for the forum mod's too, as people aren't all starting a new topic every month about that same poorly documented command, they can just look in the wiki where hopefully someone has written a simpler explanation of what the command does that everyone understands, identifying bugs with the command and workarounds.

http://notmybase.com
All my base are not belong to anyone.
Nicholas Thompson
20
Years of Service
User Offline
Joined: 6th Sep 2004
Location: Bognor Regis, UK
Posted: 13th Apr 2008 14:45
Quote: "they can just look in the wiki where hopefully someone has written a simpler explanation of what the command does that everyone understands"


Thing is - they could find that same information on this forum, if they searched (probably). Some people here are lazy and just post without looking. I'm not pointing any fingers - its likely I've posted without searching before - in fact, its probable that everyone has!

@Jerico - I do understand and agree with what you're saying... But for something like this I believe you HAVE to moderate everything otherwise you risk the Wiki simply turning into a ground for irrelevant and incorrect/incoherent information.

However I also see your point that you do certainly need a "starting point"...

[center]
El Goorf
18
Years of Service
User Offline
Joined: 17th Sep 2006
Location: Uni: Manchester, Home: Dunstable
Posted: 13th Apr 2008 17:30
Quote: "Thing is - they could find that same information on this forum, if they searched (probably). Some people here are lazy and just post without looking."


thats cos the search on this forum sucks, specially if you want something specific

http://notmybase.com
All my base are not belong to anyone.
Kentaree
22
Years of Service
User Offline
Joined: 5th Oct 2002
Location: Clonmel, Ireland
Posted: 14th Apr 2008 12:31
Nicholas, I do agree with you, but the point of a wiki is to be user-moderated. If any user sees someone writing total B.S on the wiki, they can revert the changes or edit. All you need is the amount of "good" edits outweighing the "bad".

Chris K
21
Years of Service
User Offline
Joined: 7th Oct 2003
Location: Lake Hylia
Posted: 14th Apr 2008 18:59
Wikis are the greatest thing that man has ever invented.

I know it is hard to believe that they work, but they do.

Someone starts wikipedia and it's basically just bare, and he says "Hey everyone, come and add stuff". Everyone thought it would turn into a complete mess but it HASN'T.

UNBELIEVABLY they adjust and aggregate into useful, accessible information.

What it should be, is just a normal wiki that any old fool can edit, but that Daniel is particularly committed to adding quality stuff to.

-= Out here in the fields, I fight for my meals =-
Mahoney
16
Years of Service
User Offline
Joined: 14th Apr 2008
Location: The Interwebs
Posted: 20th Jul 2008 21:43
A recently started Wiki for the DarkGDK can be found here, if anyone's interested.

http://darkgdk.wikia.com/wiki/DarkGDK_Programming_Wiki
Samoz83
21
Years of Service
User Offline
Joined: 3rd May 2003
Location: Stealing Ians tea from his moon base
Posted: 9th Aug 2008 02:16 Edited at: 9th Aug 2008 02:17
I've also started a wiki for FPSC which i start earlier this year and have just restarted the project. It can be found here

Help create the FPSC Wiki at [href]www.flaminggames.co.uk/fps2[/href]
Aurum Knight
16
Years of Service
User Offline
Joined: 15th Jul 2008
Location: the suburbs of nowhere
Posted: 9th Aug 2008 02:50
This is a good idea

When is it gonna come out? I agree with Jerich here, let the users sort it out

Maybe we can also add in commands from some dlls like cloggy's d3d, or Sparkys dll

Login to post a reply

Server time is: 2024-11-20 12:41:22
Your offset time is: 2024-11-20 12:41:22