Qbasicnews.com
January 23, 2018, 06:41:56 AM *
Welcome, Guest. Please login or register.

Login with username, password and session length
News: Back to Qbasicnews.com | QB Online Help | FAQ | Chat | All Basic Code | QB Knowledge Base
 
   Home   Help Search Login Register  
Poll
Question: Use urger's mediawiki for this?  (Voting closed: May 18, 2005, 04:28:37 PM)
Yes - 12 (85.7%)
No - 2 (14.3%)
Total Voters: 14

Pages: 1 [2] 3 4 ... 6
  Print  
Author Topic: DOCUMENTATION REVOTE  (Read 33113 times)
urger
Wandering Guru
***
Posts: 337



« Reply #15 on: May 18, 2005, 05:36:14 PM »

No need, i've allready arranged for the parent of the Wikipedia Project to host us (we'll be using Wikipedia's space and bandwith, and through them, Google's)  They've given us unlimited space and bandwith, for free, as long as we make the wiki Open Source.
It's installed and running at http://freebasic.wikicities.com. still setting up the system's details, but it's mostly running.
Logged

his sig left intentionally blank
DrV
Na_th_an
*****
Posts: 1553



WWW
« Reply #16 on: May 18, 2005, 06:33:54 PM »

I think using a Wiki rather than the XML format is a good move; I just couldn't get into the correct mindset to write tons of markup before I even wrote the content. Smiley  I'll be back at the documentation full speed after school's out and I've knocked off the remaining bugs/todos on the DOS port of fbc.
Logged
v3cz0r
I hold this place together
*****
Posts: 924



WWW
« Reply #17 on: May 18, 2005, 06:49:27 PM »

All docs of new projects seem to start with wiki's, more people can contribute, but some "standard" will be have to be followed, or it will become a mess and converting later to pdf, chm or whatever won't be simple task.

I think it would be better to host the wiki at the fb.net site itself, so more people will know about it (fb.net gets about 10k visits /mo) and more could participate (and more stupid kids will try to screw it up too, stills). More hits will be generated to fb.net too, the new sf.net project ranking takes that into account.. as nobody uses the sf.net message boards :P.
Logged

urger
Wandering Guru
***
Posts: 337



« Reply #18 on: May 18, 2005, 07:15:51 PM »

RSS feed now operational : http://freebasic.wikicities.com/index.php?title=Special:Recentchanges&feed=rss
ATOM format for those who prefer it:http://freebasic.wikicities.com/index.php?title=Special:Recentchanges&feed=atom
Logged

his sig left intentionally blank
Jofers
Been there, done that
*****
Posts: 1040



WWW
« Reply #19 on: May 18, 2005, 08:40:35 PM »

Yup.  All content will have to be strictly organized in a way that can be parsed later by a script.  Mediawiki seems to use some kind of wierd symbol formatting, but I'll bite my teeth into it tomorrow and come up with some kind of draft.

If you want to host a wiki, vic, than I suggest you do.  PS - you ever get around to wanting that website redesign...

Edit:  Okay, there's two draft pages up, which pretty much transpose information from the old format to a wiki format.

There's a lot of xhtml div-ving, which has already gotten criticism before I finished the draft Smiley.  What do you think?  This absolutely, positively, NEEDS to be organized in such a manner that can be parsed easily.  It makes my life easier, and anyone who want's a pdf or a chm format's lives easier.

HOWEVER.. If you can think of a way to organize it more efficiently (e.g.: less markup) without losing that parsing abillity, I'm open to suggestions (demands?), this being a group project and all Smiley  

Preferably, make new drafts in new pages, and link to them from the main page.
BTW:  Is there a way to use different titles on in-page linking with this thing?
Logged
rdc
Senior Member
**
Posts: 176



WWW
« Reply #20 on: May 18, 2005, 10:49:31 PM »

I undertsand the need for some sort of format, but looking over the doc spec, it is a bit too much for me. I think if you want to follow this format, then maybe someone could write a little app that has the necessary fields that we could fill in and spits out the proper format. This way it is consistent (no human error), has the proper format and won't be such a chore to produce the docs.
Logged

v3cz0r
I hold this place together
*****
Posts: 924



WWW
« Reply #21 on: May 18, 2005, 10:56:33 PM »

coWiki could be the answer, it stores all data as XML into the database, and everything seems to be really nice coded using design patterns, the only problem is.. php 5 is needed to run it, because the new class features.. fb.net is hosted on a server with php 4.x, nothing is perfect..

With the wiki hosted at fb.net i could dump the db and convert the files with some automatic tool, if docs follow a format like used for xbasic: http://www.xbasic.org/wiki/index.php?page=XstWriteString
Logged

Jofers
Been there, done that
*****
Posts: 1040



WWW
« Reply #22 on: May 18, 2005, 11:04:45 PM »

Would you like to switch to that format?  The draft I have up there divides keyword pages into:

title (description)
usage (syntax + attributes)
details (remarks, I guess)
examples (any standalone examples)
related links

The markup in there is pretty nicely formatted, but the tables are bloody insane.  You could do enough formatting with plain ol' unattributed markup

<table class='something'>
<tr>
<td> <- no class or valign or any of that.

which is the kind I like best.

The present drafts are divvied into DIVs, but they use mediawiki formatting for sections and bullets, to be easier.

== SECTION ==
<div id="subsection">
* bullet
* bullet
</div>
Logged
v3cz0r
I hold this place together
*****
Posts: 924



WWW
« Reply #23 on: May 19, 2005, 02:39:10 AM »

Alright, wiki created: http://www.freebasic.net/wiki/

I added the #DEFINE test, if the formatting seems okay, i will write a script to convert Nex's doc to the wiki format, so it can be edited later and new items can be added..

I added the fbdoc action, so you can define new:

Categories: {{fbdoc item="category" value="Some category"}}

Keywords: {{fbdoc item="keyword" value="KwSomeKeyword|KEYWORDNAME"}}

Set the title: {{fbdoc item="title" value="Keyword Name"}}

And sections:

Syntax: {{fbdoc item="syntax"}}

Description: {{fbdoc item="desc"}}

Examples: {{fbdoc item="ex"}}

Differences: {{fbdoc item="diff"}}

See also: {{fbdoc item="see"}}

More can be added later if requested..

Parsing that code won't be any hard, when one section starts, the older one ends and so on.. editing will be piece-of-cake too, IMO :P
Logged

SotSvart
Member
*
Posts: 61



WWW
« Reply #24 on: May 19, 2005, 05:55:01 AM »

Exellent! I think this could work out fine.. Is there any protection against jerks that just want to f**k things up?

Is it possible to add the defult format code to the edit window when you open a new empty command? You could offcourse cut and past, but this would make life a little bit more easy..
Logged
aetherfox
Been there, done that
*****
Posts: 1071



WWW
« Reply #25 on: May 19, 2005, 07:55:55 AM »

I like this new wiki.  I've neverh eard of it, I don't think, but it looks good.  I'll start contributing soon.

I rekon all the fb tutorials should go on on this as well.
Logged

~''i|~thrFx~|i''~-  
avinash.vora - http://www.avinashv.net
urger
Wandering Guru
***
Posts: 337



« Reply #26 on: May 19, 2005, 09:05:56 AM »

Quote
Exellent! I think this could work out fine.. Is there any protection against jerks that just want to f**k things up?

If you ever encounter a vandalized page you can use the history tab to  search the archives for the last non vandalized version and then reset the vandalized page to that one.  The wiki stores all changes so removing them is realitivly trivial.
Logged

his sig left intentionally blank
urger
Wandering Guru
***
Posts: 337



« Reply #27 on: May 19, 2005, 09:20:51 AM »

Problem with the wiki at Freebasic.net, it won;t accept any members, throwing up an error that a username is not compliant with "wikiname" conventions.
Logged

his sig left intentionally blank
urger
Wandering Guru
***
Posts: 337



« Reply #28 on: May 19, 2005, 09:47:19 AM »

I've created a proposed style for the command references based on what others have been saying.  http://freebasic.wikicities.com/wiki/Style_sample
Logged

his sig left intentionally blank
aetherfox
Been there, done that
*****
Posts: 1071



WWW
« Reply #29 on: May 19, 2005, 10:00:35 AM »

The fb.net wiki doesn't want to accept me either...
Logged

~''i|~thrFx~|i''~-  
avinash.vora - http://www.avinashv.net
Pages: 1 [2] 3 4 ... 6
  Print  
 
Jump to:  

Powered by MySQL Powered by PHP Powered by SMF 1.1.21 | SMF © 2015, Simple Machines Valid XHTML 1.0! Valid CSS!