WML documentation written in LaTeX...

[toms]

Here is the start for a WML documentation in LaTeX.
I made it because I learn the language and have to exercise.
It´s only the first part, don´t expect any good because I´m new at LaTeX.

I want to know what you think of the idea. This is not a real interesting version.

[Darth Fool]

Here is the start for a WML documentation in LaTeX.
I made it because I learn the language and have to exercise.
It´s only the first part, don´t expect any good because I´m new at LaTeX.

I want to know what you think of the idea.

(in PDF and zipped because pdf is not allowed)

I think it is a great idea, but that is probably just because I have used LaTex way too much. The big question is how to keep the WML documentation in its various locations up to date and in sync.

[scott]

Cool!

[toms]

Thank you both.

It is only work in progress, and I have to learn a lot about the language.

But as said, it´s a good exercise, and my thoughts were that I don´t like theprogramming start the wiki offers.

[Viliam]

I was thinking about a similar thing a few months ago... I wanted to write the help in a DocBook XML format, so that it could be easily compiled into CHM, HTML or PDF. But then I stopped the project because I realised it is too much work for one person -- the information has to be updated frequently, and that is best done using Wiki.

Today my idea of "best manual" is: (1) Think about how would you do a good manual in -- whatever is your favourite format -- and then (2) make wiki pages that reflect the ideal solution as closely as possible. And then maybe (3) make a script that downloads the set of wiki pages and compiles them to off-line manual.

If you do in LaTeX, the problem is that either you will do the whole thing alone (and that is too much work, there are about hundred WML tags); or you will have to find more people with both WML and LaTeX skills.

[toms]

Viliam: I know it´s much, but I´m doing this slightly, generally to learn the language better.(Don´t tell me again that I´m repeating me)

I´m doing this because I get confused on myself with the wiki stuff. This is better for more experienced WMLers. However, if this is getting more serious, I will probably upload it.

Darth Fool: About keeping it up-to-date, I think I´m better with doing it for the stable version and update it from one stable version to the next.

Generally, I think I know enough about WML to write this documentation. But as I get nothing than confused with the terrain-graphics WML. (frame called it once a perfectly good documentation, but as a non-native anglo, ) So if anyone could write a manual for this point, great. But it has no need now, better wait until this has become something.

[toms]

Sorry, that double post again...

I´ve further worked on. But it went soo slow because I tracked down over hundred errors. (as an unexperienced guy, I make many mistakes)

I deleted the old attached file, and now there is the actual version. Again, it still has no value for WML noobs

PS: I´m not a very good Englishspeaker, please point out every grammar/writing mistake you find, if you download. Same is true for false information about WML(I hope there is none).

[jg]

I think it looks very nice, and since I am quite a experienced 'Latex' user (have been using it for around 4-5 years), I know there is a lot of work in there: *huh*! What about putting the comments in the boxes, into the middle?

About mistakes: on page 2 (in the beginning), you wrote 'fifficult' instead of 'difficult'...

jg

[toms]

I think it looks very nice, and since I am quite a experienced 'Latex' user (have been using it for around 7 years), I know there is a lot of work in there: *huh*! What about putting the comments in the boxes, into the middle?

Please explain, I don´t know what you mean.

[jg]

With that sentence I meant words or phrases that were 'boxed', would go into the middle of the line... For example (if you look into your text), "command" or "/command", both on the first page. The code for Latex:

Code: Select all

...
\begin{center}
   "command" (framed or boxed, whichever you would call it)
\end{center}
...

Just a suggestion...

[toms]

Thank you, I will add this. It just caused a bug first.

And I will reformat the command explaintations. Also, you may have noticed that there is written somthing about where are the custom campaigns, and then no path. I will also do this soon, with a table where it´s listed for each OS.

[toms]

I have gone a step further, but nothing extra special.

However, I keep my system with always deleting the old attached file, so it shouldn´t be any spam.

And I hope that it fits with the most imaginations of a good documentation, because it should be the right thing for all guys. (esp. newbies)

[Viliam]

Could you please provide also a PDF version?

[scott]

Latex gave me some flak about your last itemize environment because you put the heading "Explanations" inside the environment instead of outside. It didn't like a line that was not preceded by \item. It also swallowed the brackets around [story], but I'm not inclined to look up how to print them. I'm up to my elbows in my own latex files.

This is an archive with the updated .tex and the .pdf files.

[toms]

I thought I have fixed that.

I will have a look.