project-navigation
Personal tools

Author Topic: Manual 2  (Read 4778 times)

Marx83

  • Guest
Manual 2
« on: February 15, 2008, 05:20:16 pm »
I searched the forum to see if someone was working on a exterior manual.  I did discover an old thread (from 06) and I've decided to start another.  I'm very good at creating documents, especially training materials and manuals.  I would like to assume the role of creating a Manual if noone else is currently working on one.  If someone is, let me know if I can assist.

Here is a sample of my work..

http://www.mediafire.com/?2nlmpmj0ybx

If anyone has an old copy of the previous manual, please post here.  I'd be nice not to have to start completely from scratch ;-)

Offline Mattn

  • Administrator
  • PHALANX Commander
  • *****
  • Posts: 4831
  • https://github.com/mgerhardy/vengi
    • View Profile
    • Vengi Voxel Tools
Re: Manual 2
« Reply #1 on: February 15, 2008, 05:33:17 pm »
our manual is here http://ufoai.svn.sourceforge.net/viewvc/ufoai/ufoai/trunk/src/docs/tex/

we have some contributors here - feel free to contribute, too

Offline Doctor J

  • Squad Leader
  • ****
  • Posts: 265
    • View Profile
Re: Manual 2
« Reply #2 on: March 06, 2008, 10:56:40 pm »
This looks very interesting.  Does this stuff get turned into a human readable document during the make phase?  If so, where do i find it after installing?  I'm currently using the precompiled Mac binary, and have so far seen nothing like this.

P.S.  I've heard of TeX before, but don't know anything about it.  A web search showed me lots of tutorials on using TeX to write a document, but i didn't see anything on how to read this stuff.  Could somebody point me to a proper primer?

Offline Mattn

  • Administrator
  • PHALANX Commander
  • *****
  • Posts: 4831
  • https://github.com/mgerhardy/vengi
    • View Profile
    • Vengi Voxel Tools
Re: Manual 2
« Reply #3 on: March 07, 2008, 08:48:14 am »
you have to install latex on your box and run make pdf-manual from the svn repository. This will create a pdf for you.

kraigus

  • Guest
Re: Manual 2
« Reply #4 on: March 16, 2008, 12:45:07 am »
Doctor J, you could do worse than to invest in one of the seminal books on TeX, like Leslie Lamport's.

Feel free to send me a PM or email if you have questions, I'm working on at least copyedits and style changes to the manual.  (I have a batch of edits for the last half that I need to commit to bits from paper.)

Sacrusha

  • Guest
Re: Manual 2
« Reply #5 on: March 16, 2008, 06:49:29 pm »
The best introduction to LaTeX I know:

http://www.google.com/search?q=not+so+short+LaTeX

Offline wrwrwr

  • Rookie
  • ***
  • Posts: 19
    • View Profile
Re: Manual 2
« Reply #6 on: March 20, 2008, 07:31:25 am »
Maybe it's also worth noting that there are different editors for latex, not exactly wysiwig, but highlighting, completion, wizards etc. can help a lot, especially until you know the language well.

One that i've used is Kile (for KDE; http://sourceforge.net/projects/kile/), but there's at least one for windows too.