Developer forums (C::B DEVELOPMENT STRICTLY!) > Development
Documentation in various formats
David Perfors:
In reply on this topic I open a new topic.
A summary of the topic:
It would be usefull to have documentation that could be spread in several formats (like CHM, PDF, HTML). This documentation should discribe how Code::Blocks works (the manual). A manual/help file should be included with the installation package od C::B so people have it on there computer. Also there should be a version on the internet so people could always read the newest changes.
The problem is where do we put the documentation. On the wiki? then it should be possible to export it to other formats. So are there other options? (LaTeX?)
darklordsatan:
What exactly do you mean exporting to other formats? Do you reffer that the main format of the docs should be flexible to allow this?
And what is exactly the problem you're having here:
--- Quote from: mispunt ---
it is a problem, I can't export wiki pages... (as far as I can see, perhaps an admin is able to do it?)
--- End quote ---
David Perfors:
--- Quote from: darklordsatan ---What exactly do you mean exporting to other formats? Do you reffer that the main format of the docs should be flexible to allow this?
--- End quote ---
The main format of the doc should be flexible indeed, else we can get troubles with exporting to other formats.
--- Quote from: darklordsatan ---And what is exactly the problem you're having here:
--- Quote from: mispunt ---
it is a problem, I can't export wiki pages... (as far as I can see, perhaps an admin is able to do it?)
--- End quote ---
--- End quote ---
You where talking about the format, and I reply to that (I know, I had to quote you :oops:)
darklordsatan:
Well I think the Doc idea is very neat (I was about to submit a request on this), and should be done ASAP (obviously with the help of non-developers - developers should have enough taks for now!), because once Code::Blocks becomes better and adds more functionality, then the docs will grow up...
Id like to see people opinion on the main format...
Anyway, whatever it might be, I think the starters would be:
1. Create a section-subsection map regarding every topic the docs should cover
2. Create a template for the subsections-sections and the articles itself - This should be done in the docs "main" format to decide yet
3. Agree in which should be the main "source" where documenters should modify/add new articles. From what I know, CVS can handle this, but it would be a pain for people with difficulties accesing the CVS repository, so the first idea is the Wiki
4. Assign someone (or maybe a couple people) to administer the docs, and create the main doc file (directly, or taking the docs from the wiki for example and converting them to the specified format) once its in a stable shape, ready for distribution.
Another thing that I think would be nice is to have images along the tutorials; this should be a plus for newbies who surely wouldnt loose themselves and would provide a more accurate description of whats being explained in a given doc
Notice there should be two kinds of formats:
[*]The main source format
[*]The main distribution format
[/list:u]
For the second one, I think CHM is the best alternative, since it simply, rocks, besides, I think wxwidgets can handle CHM in Linux as well, amI right?
For the first one, we're yet to see, I think Latex is complicated and with the lack of a good WYSIWYG editor...
Just some thoughts, probably theyre worthless anyway
@mispunt: What did you mean? I was asking you about the problem you said you had "exporting" the wiki, what was that problem? :smile:[/list]
David Perfors:
--- Quote from: darklordsatan ---@mispunt: What did you mean? I was asking you about the problem you said you had "exporting" the wiki, what was that problem? :smile:
--- End quote ---
There is no button/link called "export" :)
Navigation
[0] Message Index
[#] Next page
Go to full version