Author Topic: Documentation  (Read 1380 times)

Offline WizWom

  • Wandering Kernel of Happiness
  • Planewalker
  • *****
  • Posts: 143
  • Gender: Male
Documentation
« on: August 27, 2006, 07:31:32 AM »
The documentation packaged with WeiDU is in TEX format.

WTF?  Why?  It's not like you're going to be typesetting anything in there, let alone mathematical formulae.

PLEASE SOMEWHERE... anywhere - put up documentation is a decent format; I really don't want to bother downloading and installing a TEX layout program for a single bloody stupid app.
If you aren't happy, it's not my fault.

Offline Grim Squeaker

  • Fallen
  • Planewalker
  • *****
  • Posts: 1019
  • Gender: Male
Re: Documentation
« Reply #1 on: August 27, 2006, 07:38:40 AM »
Documentation in html format.  This has been packaged with WeiDU for as long as I've been using it.
"You alone can make my song take flight..."

Offline WizWom

  • Wandering Kernel of Happiness
  • Planewalker
  • *****
  • Posts: 143
  • Gender: Male
Re: Documentation
« Reply #2 on: August 27, 2006, 08:01:00 AM »
Wasn't in my .192 source distribution.
If you aren't happy, it's not my fault.

Offline the bigg

  • The Avatar of Fighter / Thieves
  • Moderator
  • Planewalker
  • *****
  • Posts: 3804
  • Gender: Male
Re: Documentation
« Reply #3 on: August 27, 2006, 08:05:44 AM »
I'm pretty sure it's in both SRC and binary distributions.
Author or Co-Author: WeiDU (http://j.mp/bLtjOn) - Widescreen (http://j.mp/aKAiqG) - Generalized Biffing (http://j.mp/aVgw3U) - Refinements (http://j.mp/bLHoCc) - TB#Tweaks (http://j.mp/ba02Eg) - IWD2Tweaks (http://j.mp/98OFYY) - TB#Characters (http://j.mp/ak8J55) - Traify Tool (http://j.mp/g1Ry9A) - Some mods that I won't mention in public
Maintainer: Semi-Multi Clerics (http://j.mp/9UeIwB) - Nalia Mod (http://j.mp/dng9l0) - Nvidia Fix (http://j.mp/aRWjjg)
Code dumps: Detect custom secondary types (http://j.mp/hVzzXG) - Stutter Investigator (http://j.mp/gdtBn8)

If possible, send diffs, translations and other contributions using Git (http://j.mp/aBZFrq).

Offline Grim Squeaker

  • Fallen
  • Planewalker
  • *****
  • Posts: 1019
  • Gender: Male
Re: Documentation
« Reply #4 on: August 27, 2006, 08:07:00 AM »
I'm pretty sure it's in both SRC and binary distributions.

It's definitely in both versions of 195.
"You alone can make my song take flight..."

Offline WizWom

  • Wandering Kernel of Happiness
  • Planewalker
  • *****
  • Posts: 143
  • Gender: Male
Re: Documentation
« Reply #5 on: August 27, 2006, 09:27:31 AM »
OK, found it - README-Weidu.html is not DOCUMENTATION-WeiDU.html.  A README is for describing possible issues with installation and running the product.  Not for a functional description of the product.

Goofball foreigners :-)
If you aren't happy, it's not my fault.

Offline SimDing0

  • Back In Black
  • Global Moderator
  • Planewalker
  • *****
  • Posts: 3496
  • Gender: Male
  • Word Enhancer
Re: Documentation
« Reply #6 on: August 27, 2006, 09:37:11 AM »
are you the funny?

Offline Andyr

  • Dance Commander
  • PPG
  • Planewalker
  • *****
  • Posts: 3178
  • Gender: Male
    • The Gibberlings Three IE mod community
Re: Documentation
« Reply #7 on: August 27, 2006, 09:41:50 AM »
Goofball foreigners :-)

I'm pretty sure Wes is, like your profile suggests you are, American.
"We are the Gibberlings Three, as merry a band as you ever did see..." - Home of IE mods

<jcompton> Suggested plugs include "Click here so Compton doesn't ban me. http://www.pocketplane.net/ub"

I am unfortunately not often about these days so the best way to get hold of me is via email.

Offline the bigg

  • The Avatar of Fighter / Thieves
  • Moderator
  • Planewalker
  • *****
  • Posts: 3804
  • Gender: Male
Re: Documentation
« Reply #8 on: August 27, 2006, 09:43:17 AM »
I'm pretty sure Wes is, like your profile suggests you are, American.
BUT I AM ITALIAN, SO IT MUST BE MY FAULT!!!11111111
Author or Co-Author: WeiDU (http://j.mp/bLtjOn) - Widescreen (http://j.mp/aKAiqG) - Generalized Biffing (http://j.mp/aVgw3U) - Refinements (http://j.mp/bLHoCc) - TB#Tweaks (http://j.mp/ba02Eg) - IWD2Tweaks (http://j.mp/98OFYY) - TB#Characters (http://j.mp/ak8J55) - Traify Tool (http://j.mp/g1Ry9A) - Some mods that I won't mention in public
Maintainer: Semi-Multi Clerics (http://j.mp/9UeIwB) - Nalia Mod (http://j.mp/dng9l0) - Nvidia Fix (http://j.mp/aRWjjg)
Code dumps: Detect custom secondary types (http://j.mp/hVzzXG) - Stutter Investigator (http://j.mp/gdtBn8)

If possible, send diffs, translations and other contributions using Git (http://j.mp/aBZFrq).

Offline cmorgan

  • Planewalker
  • *****
  • Posts: 1424
  • Gender: Male
  • Searcher of Bugs
Re: Documentation
« Reply #9 on: August 27, 2006, 11:43:23 AM »
ummm... I think for documentation (i.e. standard reference materials regarding base installation and usage of freely distributed programs, etc.) the "modern" (read that as anything past 1988 or 1989) approach is to assume user stupidity:
1 file, usually txt or htm, labelled ReadMe (Because older Dos file structures didn't allow for filenames like YoStupidIdiotYouNeedToReadThisBeforeYouTrashYourWholeSystemAndComeCryingToMe.txt, and when the user looks at the directory structure or file folder it stands out and screams "Read ME!!!") which includes all pertinent documentation including technical definitions, documentation of usage, installation instructions, etc; Games differ slightly from programs by sometimes including  a "walkthrough" or "FAQ".

I have not seen "documentation" separated. In fact, it looks like (and I am now using) the wave of the future is "readMe as interlinked html or xml based web archive", where the ReadMe is a table of contents linking to either in-document anchors or related pages; a one-stop-shop for all information related to the program.

Pardon me if I appear pendantic and lecturing... but as a true Taxpayin' UN-Hatin' Gun Totin' World Conkerin' Amurukun Dude, I just had to make sure our side of the Big Pond was getting the facts straight   :)

Although we all know it is a big Italian Conspiracy to rule the world by hiding important information on World Domination Through WeiDU Distribution from us US users. And if I recall correctly, Wes can't be truly called American... he's from California, which everybody knows is a world (or universe) unto itself! ;D



 

With Quick-Reply you can write a post when viewing a topic without loading a new page. You can still use bulletin board code and smileys as you would in a normal post.

Warning: this topic has not been posted in for at least 120 days.
Unless you're sure you want to reply, please consider starting a new topic.

Name: Email:
Verification:
Type the letters shown in the picture
Listen to the letters / Request another image
Type the letters shown in the picture:
What color is grass?:
What is the seventh word in this sentence?:
What is five minus two (use the full word)?: