Author Topic: Preliminary documentation  (Read 17674 times)

Offline Biplab

  • Developer
  • Lives here!
  • *****
  • Posts: 1874
    • Biplab's Blog
Re: Preliminary documentation
« Reply #30 on: June 27, 2007, 01:40:07 pm »
With LaTeX you develop documents, just the very same as you develop C::B. ;-)

This is the beauty of LaTeX. :)

So the question remains. Do I need to learn LaTeX to contribute something to a Document??

The answer is No (largely). It's a tagged language. So the major portion of LaTeX code will be of pure text only. Tags are necessary only in few places. For formatting you need to know couple of Tags (should you want to format them), but that shouldn't be a big headache. :)

So what's the purpose of the Wiki after this documentation hits the SVN?

You can use it as an Online Documentation. :)

Other difference is Wiki will remain User-Editable but the SVN doc will not.
Be a part of the solution, not a part of the problem.

Offline MortenMacFly

  • Administrator
  • Lives here!
  • *****
  • Posts: 9597
Re: Preliminary documentation
« Reply #31 on: June 27, 2007, 01:45:11 pm »
I will try to send the sources of the documentation this week.
Nice! :-) Looking forward to it...

I just fear that soon you have two documentation systems both containing outdated information.
I think this is an issue. Hence the documentation needs some sync. I believe the WiKi can act as a good scratchpad for the docu. Once an article looks nice there it can be transferred into the docu. (This is mostly a copy&paste operation, really.) Out of the docu a webpage can be built automatically (maybe even using XSLT for nice style or something) but not a WiKi.
With regards, Morten.
Compiler logging: Settings->Compiler & Debugger->tab "Other"->Compiler logging="Full command line"
C::B Manual:

Offline mariocup

  • Developer
  • Lives here!
  • *****
  • Posts: 586
Re: Preliminary documentation
« Reply #32 on: June 27, 2007, 01:49:30 pm »
Hi Artoj,

if there is an output specification of wiki, perhaps we can generate the wiki format from the docu sources. This would be the best solution.
We could write a XSLT script to convert to the wiki format.



Offline artoj

  • Almost regular
  • **
  • Posts: 206
  • Location: Supporting my team
Re: Preliminary documentation
« Reply #33 on: June 27, 2007, 09:00:16 pm »
I just hope that there will be someone who coordinates the documentation writing between the Wiki and the SVN. IMO, documentation duplication creates unneeded extra work for this project.

Offline dmoore

  • Developer
  • Lives here!
  • *****
  • Posts: 1576
Re: Preliminary documentation
« Reply #34 on: July 20, 2007, 03:38:35 am »
for those unfamiliar with latex, I've found this site useful (lots of examples, plus a pdf book):