ENIGMA Forums

General fluff => Announcements => Topic started by: Josh @ Dreamland on May 25, 2010, 09:23:55 PM

Title: Documentation
Post by: Josh @ Dreamland on May 25, 2010, 09:23:55 PM
ENIGMA's spent most of its life without a decent documentation. Now it gets a colorful one.

Gary (MahFreenAmeh) and I have been working over the last couple days (between his work and my stats project, now complete) on a parser to convert plain-text documentation into a rather lovely visual display. The display is meant for newer browsers with real features. This basically excludes IE automatically.

Anyway, the first of the documentation (thrown together only for purposes of testing the parser, so it's kind of ugly yet anyway) can be viewed here:
http://enigma-dev.org/docs/pages/test

For now, the docs use PNG. All PNGs, including the ENIGMA Logo, are merely renders of SVGs, which the docs will use ASAP. I want an all-text documentation, basically. Docs themselves being plain text, images being SVG which, as I'm sure most of you know, is just XML.

Anyway, do view the test page and post your thoughts. Feel free to recommend ways to beautify or simplify.
Do not complain that the layout uses tables, or I will track you down and murder you in a highly creative manner.

I guess I will start typing up more docs as soon as Gary has a method of adding to them arranged.

Should be interesting.

Peace. Unless you have a vendetta against tables.
Title: Re: Documentation
Post by: retep998 on May 25, 2010, 09:26:05 PM
WTF
Why does your layout use tables?
Go learn css you noob.

(User was banned for this post ("Read the post before consulting the reason" - Josh @ Dreamland))
Title: Re: Documentation
Post by: jaycliff on May 26, 2010, 12:00:35 AM
Nice. This is a great start.  :cool:
Title: Re: Documentation
Post by: IsmAvatar on May 26, 2010, 12:11:24 AM
Actually I'm with everyone else. You really should drop the tables.
Title: Re: Documentation
Post by: Josh @ Dreamland on May 26, 2010, 02:35:38 AM
*calmly replaces tables with divs*
Title: Re: Documentation
Post by: kkg on May 26, 2010, 03:08:20 AM
The pictures at the top go through the top of the page >:
Otherwise it's okay I suppose.
Title: Re: Documentation
Post by: IsmAvatar on May 26, 2010, 08:00:56 AM
kkg: You came in late. The intended look was achieved with tables, and there was a margin at the top so the images didn't get chopped off. I'm guessing his switch to divs is still a work in progress.
The effect should be achieved with a margin-top.
Title: Re: Documentation
Post by: luiscubal on May 26, 2010, 03:34:14 PM
It's visually appealing and nice, but I don't want to have to browse it when it reaches 1000s of functions documented.
Title: Re: Documentation
Post by: Josh @ Dreamland on May 26, 2010, 04:07:08 PM
Luis: This isn't the format for function documentation; only for system overviews and philosophical goo.
Title: Re: Documentation
Post by: MahFreenAmeh on May 26, 2010, 04:49:00 PM
FUNCTION DOCUMENTATION TIME.
wat.
Title: Re: Documentation
Post by: Josh @ Dreamland on May 26, 2010, 10:28:54 PM
Pleased to report that the layout no longer sucks in Webkit-based browsers (namely, Chrome, Safari). In fact, now it no longer sucks in Firefox, either.
Title: Re: Documentation
Post by: retep998 on May 26, 2010, 11:06:50 PM
The layout totally sucks

(User was banned for this post ("Three times in two days!" - Josh @ Dreamland))
Title: Re: Documentation
Post by: Rusky on May 27, 2010, 10:21:25 AM
I can has fluid width?
Title: Re: Documentation
Post by: retep998 on May 27, 2010, 01:35:50 PM
The layout STILL sucks
When are you going to fix the css?
Title: Re: Documentation
Post by: Josh @ Dreamland on May 27, 2010, 10:34:52 PM
Rusky: Actually, that does look okay. Set at 90%.

retep998:
:troll:
Title: Re: Documentation
Post by: freezway on May 30, 2010, 12:43:19 PM
YOU FORGOT TO PUT THE TITLE OF WHAT YOU ARE DOCUMENTING AT THE TOP!!! 0_o?!?!?!