Developer forums (C::B DEVELOPMENT STRICTLY!) > Development

Documentation in various formats

<< < (8/10) > >>

RShadow:

--- Quote from: kagerato ---
Now you're the one being silly Very Happy .
[snip]

--- End quote ---


Kagerato I think we are on the same page here, Just misunderstood.  I wouldn't propose that chm's and/or man pages be maintained seperatly.. that would be a horrible idea indeed.


--- Quote from: darklordsatan ---
Ok, lets not get into flame wars here (well, sort of).
[snip]

--- End quote ---

I agree with everything you propose.  Using docbook's SGML / XML format (I guess it first needs to be decided what DTD we would use) will allow us to very easily transform the docbook sources into whatever format floats are boat at the time.

As far as manpages not really making sense for an IDE, I agree.  I think we should use whatever format wx supports nativly (CHM apparently) to do whatever kind of help system the IDE will support.  manpage's (for me anyways) only really make sense for the SDK.  When I'm working on code for C::B and various related stuff (like the scon's build) I don't use C::B. I would imagine most other dev's that are linux users do the same.. and manpages of the SDK would be helpfull.


--- Quote from: mispunt ---
I agree with this. we probably should use the cvs to store the sources...

--- End quote ---

I think using CVS to store the documentation makes the most sense.  Whatever comes out of mandrav doing the nightly snapshots, lets just not forget to do nightly snapshots of the doc's too :)

kagerato:

--- Quote from: mispunt ---The main reason the have PDF format is to make printing the documentation easy.
--- End quote ---


Aye, PDFs are useful for that.  Their primary purpose from initial design, I believe, was to create a WYSIWYG printing format.  Portability of the portable document format was just adobe's scheme to get their technology widely adopted.

Years ago I had a strong distaste for Adobe and their products, but PDF has proven its worth over time.


--- Quote from: RShadow ---Kagerato I think we are on the same page here, Just misunderstood. I wouldn't propose that chm's and/or man pages be maintained seperatly.. that would be a horrible idea indeed.
--- End quote ---


Agreed.

David Perfors:

--- Quote from: RShadow ---and manpages of the SDK would be helpfull.
--- End quote ---
This is possible, we just have to activate it in the doxygen file.
I think it is usefull to have the whole sdk documentation available for download when releasing Code::Blocks 1.0 (read: official stable release). This gives the developers time to document the whole sdk (because I doesn't see everything in the documentation)

jmccay:
So what was decided?  Docbook for the source document  to generate other possible documents?  Also, does anyone know of any good XML editors?  Where is a good play to get started and up and running with both Docbook, and XML.  I've been able to figure out some of XML from looking at files.  Thank you in advance, and good luck with the great Unicode race.

Joe.

David Perfors:
I think docbook is the best choice, but we never get a "taste" of it.

I don't know any good xml editor, I will probably use Notepad or VI.

I think someone has to start producing the necesary files for a good start, but I am not able to help with that, because I am to bussy with work(read: term of probation)  So if there are volunteers to do this, please tell us...

Navigation

[0] Message Index

[#] Next page

[*] Previous page