Qbasicnews.com
January 21, 2021, 02:57:09 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  
Pages: [1] 2
  Print  
Author Topic: FB docs  (Read 7608 times)
lillo
Guru
**
Posts: 269


WWW
« on: January 04, 2005, 08:16:00 AM »

Yet another reason why QB was so great and easy to use was its online help system inside the IDE.
Once FB is finalized enough, docs will have to be started; what if we use a common format from which to generate the same docs in different formats? Simple TXT, RTF or HTML come to mind. The Allegro library uses this approach with its own makedoc utility; I propose we write our own. The "source" docs could use XML syntax, or whatever we think is easier to write.
If it is written well enough, this tool could also generate docs for IDEs to use, ala QB...
Logged

ngelo Mottola - EC++
Sterling Christensen
Na_th_an
*****
Posts: 1328


« Reply #1 on: January 04, 2005, 10:37:47 AM »

I agree.

Here's all the discussion on documentation that I can find with a simple search for the word "documentation" in the FreeBASIC section, in rough chronological order:
For all the Documentatiaholics (Nov 14)
Documentatering (Dec 2)
Son of Documentato vs. MechaDocumentato (Dec 10)
Documentiomanary Wiki (Dec 12)
All About FreeBasic Documentation (Dec 22)
Unless I missed something I think that bring you up to date on FB documentation. You only really need to read the last one that has a link to a sourceforge project Jofers set up - the other threads are mostly brainstorming/speculation.
Logged
adosorken
*/-\*
*****
Posts: 3655



WWW
« Reply #2 on: January 04, 2005, 10:50:20 AM »

I began my own documentation for my IDE project, since waiting around for some kind of standardized format was becoming too much of a wait. Cheesy
Logged

I'd knock on wood, but my desk is particle board.
Z!re
*/-\*
*****
Posts: 4599


« Reply #3 on: January 04, 2005, 01:37:55 PM »

You're all talking about a standardized doc format, and noone can agree on one.

So, all stfu, and go with bbcode, it's all you need, it's easy to parse, and everyone knows it.

There, happy? Cheesy
Logged
Nexinarus
Wandering Guru
***
Posts: 301



WWW
« Reply #4 on: January 04, 2005, 05:47:39 PM »

I've been writing docs for about a month now, in my own doc creater with a simple "bb-code" like format. Most of the doc creater is finished and about 1/6 of the commands are documented.
Logged
adosorken
*/-\*
*****
Posts: 3655



WWW
« Reply #5 on: January 04, 2005, 05:51:30 PM »

My doc creator is Notepad. My format is HTML. To anyone who whines: I don't see YOU doing anything, so shup. Cheesy
Logged

I'd knock on wood, but my desk is particle board.
Dean
Member
*
Posts: 67


WWW
« Reply #6 on: January 04, 2005, 06:59:24 PM »

Absolutely.   I've been using PDS 7.1 for years and I love
the IDE with the built in help with details and examples.
Since most of the FB functions are similar to QB, why don't
we start by taking the QB help file and copying it in the FBIDE?  Theoretically, the same examples should produce the same
results in most cases, and it's already done.

 :bounce:
Logged
quinn
New Member

Posts: 4


« Reply #7 on: January 04, 2005, 07:24:36 PM »

That would most likely be a violation of Microsoft's copyright. Tongue

Anyhow, if any unified effort to pick a format develops, I would suggest docbook sgml? It's similar to HTML and can be converted into all sorts of other formats.  (html, pdf, UNIX man/infopage, Windows CHM, etc)

Wikipedia has some nice info on it at http://en.wikipedia.org/wiki/DocBook
Logged
The Car
Member
*
Posts: 48


« Reply #8 on: January 04, 2005, 08:31:06 PM »

I don't know if this has been inferred, but in case it hasn't..

One of the things I enjoyed about QB (and VB, VC, ...) is the ability to hit F1 when the cursor is over a keyword/function to bring up [context sensitive] help.

It would also be handy to have doc modules that do the same for opengl, etc. for easy reference, so you could hit F1 over say, glRotatef if you forget what it does. (Ok, bad example =)

Or do you guys think this is overkill?
Logged

ric Carr
adosorken
*/-\*
*****
Posts: 3655



WWW
« Reply #9 on: January 04, 2005, 08:37:20 PM »

Quote from: "The Car"
I don't know if this has been inferred, but in case it hasn't..

One of the things I enjoyed about QB (and VB, VC, ...) is the ability to hit F1 when the cursor is over a keyword/function to bring up [context sensitive] help.

It would also be handy to have doc modules that do the same for opengl, etc. for easy reference, so you could hit F1 over say, glRotatef if you forget what it does. (Ok, bad example =)

Or do you guys think this is overkill?

I've already got that set to go in my own IDE. Cheesy By the way, what took you so long to get here? Tongue Cheesy
Logged

I'd knock on wood, but my desk is particle board.
DrV
Na_th_an
*****
Posts: 1553



WWW
« Reply #10 on: January 04, 2005, 09:23:39 PM »

aargggh!

http://forum.qbasicnews.com/viewtopic.php?t=7686

www.sf.net/projects/freebasicdoc
Logged
v3cz0r
I hold this place together
*****
Posts: 924



WWW
« Reply #11 on: January 04, 2005, 09:44:59 PM »

Yeah, jofers and DrV are writing the docs, using XML iir. Jofers is about to send me the html ver to add to fb's site, a .chm version could be added to the Windows release then, i guess -- many Windows IDE's accept loading chm docs passing the current word as index and such.
Logged

zydon
Member
*
Posts: 69



« Reply #12 on: January 04, 2005, 10:20:31 PM »

while waiting the documentations completed, i think it is best to place the keywords.txt there in docs page. at it's look proper and occupied the empty space on the section.
Logged

 = inc() Cheesy
adosorken
*/-\*
*****
Posts: 3655



WWW
« Reply #13 on: January 04, 2005, 10:32:29 PM »

Well hurry up and release some files, guys! Cheesy j/k

I'll make a .chm from the HTML files, if no one else wants to take it up. .chm and I get along very well. Cheesy
Logged

I'd knock on wood, but my desk is particle board.
Jofers
Been there, done that
*****
Posts: 1040



WWW
« Reply #14 on: January 04, 2005, 10:42:46 PM »

Hey Everybody.  

http://sourceforge.net/projects/freebasicdoc/

If you're interested in helping out documentating, register at sf.net and I'll give you developer access.  We're just adding pages to the CVS, one at a time, using the table of contents as a reference.  The format is xml, which is really just xhtml with made up tags.  Just organizing the data in some structural manner, and letting someone else decide the layout.

V1c, I never really meant the first HTML page, I meant a recruitment page.  I'll whip up an xsl page soon though, as a demo.  In the end I[ll be making a batch transformer in PHP or Java based on the header tag, so you don't have to sit there with xsl tags on every page.  I'll see what my work schedule is tomorrow.  Be checking your PM.
Logged
Pages: [1] 2
  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!