To SSH, Scorporius, and all AGS scripting "experts"...

Started by TerranRich, Fri 04/07/2003 04:26:12

Previous topic - Next topic

TerranRich

Whew. The more and more similar examples I see, the less enthusiastic I become over making an online code snippet repository.  :o
Status: Trying to come up with some ideas...

Scummbuddy

No, no.  It's still a great idea.  Using RickJ's Module Tester as a basis, we could make a searchable or just a beautiful code database.
- Oh great, I'm stuck in colonial times, tentacles are taking over the world, and now the toilets backing up.
- No, I mean it's really STUCK. Like adventure-game stuck.
-Hoagie from DOTT

TerranRich

Yeah but the problem is, I don't really understand it. It's all Greek to me. I was originally just going to do everything in HTML and not make it too complicated.
Status: Trying to come up with some ideas...

Scorpiorus

Guys, do you mean Rick's docbook? :P I think it would be great to format all the tutorials this way.

Also it would be nice to implement the search engine as well... Having all the code at the one site becomes pretty necessary then.

-Cheers

RickJ

If an "open source" or "tutorial" or "game template" category was added to the AGS games page or a similar mechanism then everything wouldn't need to be hosted in the same place.  

Also if there were some common guidelines as to structure and content of the tutorial and examples then  there would be some degree of consistency betwen authors.  Currently there are a lot of variations only because there wasn't a suggested example to follow.  Now what I am suggesting are some minimal requirements such as everyone providing the source code in a common format (be it templates, txt files, or whatever), a runnning example, and a document describing what the code does, how it does it, and how it can be applied.  

Here is a brief explanation of how DocBook works.  Hope this helps weveryone's understanding.
QuoteDocBook is just a document "compiler" that takes a source xml file and creates an output file in one of a number of formats, including HTML, PDF, CHM, and others.  The look of the output is controlled by other xml files similar to html style sheets.   So if one wanted to chage the look and feel they would just change the style sheets and re-compile everything.



SSH

Another possibility, similar to DocBook, is to use the POD (Plain Old Documentation) that perl and some GNU projects use. There are converters to HTML, postscript, UNIX man pages, etc. already knocking about for free and you put the stuff as comments in your code so that is can be seen there, or in a reference manual if you run ti through one of the filters.
12

SMF spam blocked by CleanTalk