Josh @ Dreamland
|
|
Posted on: May 25, 2010, 09:23:55 pm |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
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/testFor 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
|
|
|
|
|
|
Josh @ Dreamland
|
|
Reply #4 Posted on: May 26, 2010, 02:35:38 am |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
*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
|
|
|
|
|
|
Josh @ Dreamland
|
|
Reply #8 Posted on: May 26, 2010, 04:07:08 pm |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
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
|
|
|
MahFreenAmeh
|
|
Reply #9 Posted on: May 26, 2010, 04:49:00 pm |
|
|
sysadmin
"Web Team" Location: Austin, TX Joined: Apr 2008
Posts: 13
|
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.
|
|
|
Josh @ Dreamland
|
|
Reply #10 Posted on: May 26, 2010, 10:28:54 pm |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
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
|
|
|
|
|
|
Josh @ Dreamland
|
|
Reply #14 Posted on: May 27, 2010, 10:34:52 pm |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
Rusky: Actually, that does look okay. Set at 90%. retep998:
|
|
« 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
|
|
|
|