Pages: 1 2 »
  Print  
Author Topic: Documentation  (Read 2883 times)
Offline (Male) Josh @ Dreamland
Posted on: May 25, 2010, 09:23:55 PM

Prince of all Goldfish
Developer
Location: Pittsburgh, PA, USA
Joined: Feb 2008
Posts: 2949

View Profile Email
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.
Logged
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble
"I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
Offline (Male) retep998
Reply #1 Posted on: May 25, 2010, 09:26:05 PM

Member
Location: Where else?
Joined: Jan 2010
Posts: 248
MSN Messenger - retep998@charter.net AOL Instant Messenger - retep998 Yahoo Instant Messenger - retep998
View Profile Email
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))
« Last Edit: May 25, 2010, 09:36:37 PM by Josh @ Dreamland » Logged
Offline (Unknown gender) jaycliff
Reply #2 Posted on: May 26, 2010, 12:00:35 AM
Member
Joined: Mar 2009
Posts: 1

View Profile
Nice. This is a great start.  :cool:
Logged
Offline (Female) IsmAvatar
Reply #3 Posted on: May 26, 2010, 12:11:24 AM

LateralGM Developer
LGM Developer
Location: Pennsylvania/USA
Joined: Apr 2008
Posts: 886

View Profile Email
Actually I'm with everyone else. You really should drop the tables.
Logged
Offline (Male) Josh @ Dreamland
Reply #4 Posted on: May 26, 2010, 02:35:38 AM

Prince of all Goldfish
Developer
Location: Pittsburgh, PA, USA
Joined: Feb 2008
Posts: 2949

View Profile Email
*calmly replaces tables with divs*
Logged
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble
"I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
Offline (Male) kkg
Reply #5 Posted on: May 26, 2010, 03:08:20 AM

Member
Location: Australia
Joined: Nov 2009
Posts: 84
MSN Messenger - kamikazigames@gmail.com
View Profile Email
The pictures at the top go through the top of the page >:
Otherwise it's okay I suppose.
Logged
PC: Core i7-2600 @ 3.8ghz | 4x 4gb G.Skill RipjawZ DDR3-2000 | GTX580 | Win7 x64
Time is the greatest teacher, however it kills every single one of its pupils.
Offline (Female) IsmAvatar
Reply #6 Posted on: May 26, 2010, 08:00:56 AM

LateralGM Developer
LGM Developer
Location: Pennsylvania/USA
Joined: Apr 2008
Posts: 886

View Profile Email
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.
Logged
Offline (Unknown gender) luiscubal
Reply #7 Posted on: May 26, 2010, 03:34:14 PM
Member
Joined: Jun 2009
Posts: 452

View Profile Email
It's visually appealing and nice, but I don't want to have to browse it when it reaches 1000s of functions documented.
Logged
Offline (Male) Josh @ Dreamland
Reply #8 Posted on: May 26, 2010, 04:07:08 PM

Prince of all Goldfish
Developer
Location: Pittsburgh, PA, USA
Joined: Feb 2008
Posts: 2949

View Profile Email
Luis: This isn't the format for function documentation; only for system overviews and philosophical goo.
Logged
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble
"I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
Offline (Male) MahFreenAmeh
Reply #9 Posted on: May 26, 2010, 04:49:00 PM

sysadmin
"Web Team"
Location: Austin, TX
Joined: Apr 2008
Posts: 13
AOL Instant Messenger - sirmxe
View Profile WWW Email
FUNCTION DOCUMENTATION TIME.
wat.
Logged
sys(tem)admin(istrator)
[java,c++,c,javascript,html,css,php,perl,ruby,python,sql]
if you've got ideas, let me hear them.
Offline (Male) Josh @ Dreamland
Reply #10 Posted on: May 26, 2010, 10:28:54 PM

Prince of all Goldfish
Developer
Location: Pittsburgh, PA, USA
Joined: Feb 2008
Posts: 2949

View Profile Email
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.
Logged
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble
"I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
Offline (Male) retep998
Reply #11 Posted on: May 26, 2010, 11:06:50 PM

Member
Location: Where else?
Joined: Jan 2010
Posts: 248
MSN Messenger - retep998@charter.net AOL Instant Messenger - retep998 Yahoo Instant Messenger - retep998
View Profile Email
The layout totally sucks

(User was banned for this post ("Three times in two days!" - Josh @ Dreamland))
« Last Edit: May 26, 2010, 11:23:08 PM by Josh @ Dreamland » Logged
Offline (Male) Rusky
Reply #12 Posted on: May 27, 2010, 10:21:25 AM

Resident Troll
Joined: Feb 2008
Posts: 955
MSN Messenger - rpjohnst@gmail.com
View Profile WWW Email
I can has fluid width?
Logged
Offline (Male) retep998
Reply #13 Posted on: May 27, 2010, 01:35:50 PM

Member
Location: Where else?
Joined: Jan 2010
Posts: 248
MSN Messenger - retep998@charter.net AOL Instant Messenger - retep998 Yahoo Instant Messenger - retep998
View Profile Email
The layout STILL sucks
When are you going to fix the css?
Logged
Offline (Male) Josh @ Dreamland
Reply #14 Posted on: May 27, 2010, 10:34:52 PM

Prince of all Goldfish
Developer
Location: Pittsburgh, PA, USA
Joined: Feb 2008
Posts: 2949

View Profile Email
Rusky: Actually, that does look okay. Set at 90%.

retep998:
:troll:
« Last Edit: May 27, 2010, 10:40:15 PM by Josh @ Dreamland » Logged
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble
"I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
Pages: 1 2 »
  Print