Code::Blocks

User forums => General (but related to Code::Blocks) => Topic started by: mariocup on July 19, 2009, 12:46:44 am

Title: Update of the CB user manual
Post by: mariocup on July 19, 2009, 12:46:44 am
Dear Code::Blocks users,

the user manual of Code::Blocks has been updated and includes now documentation for the latest CB features. The manual is intended as an addition to the Code::Blocks wiki documentation and to give new users useful hints to start with Code::Blocks. If you have any suggestions please let me know (any feedback is welcome :D).

 
Title: Re: Update of the CB user manual
Post by: ollydbg on July 19, 2009, 03:49:16 am
Thanks for your contribution!!

But, where can I find the new user manual.
I download this manual from:
http://www.codeblocks.org/images/docs/manual_en.pdf

It seems the PDF was created in 20090217.

So, where is the newest manual?

Title: Re: Update of the CB user manual
Post by: mandrav on July 19, 2009, 10:51:53 am
Try http://www.codeblocks.org/docs/manual_en.pdf
Title: Re: Update of the CB user manual
Post by: ollydbg on July 19, 2009, 03:50:36 pm
Try http://www.codeblocks.org/docs/manual_en.pdf
It is still an old version... :(
Title: Re: Update of the CB user manual
Post by: mariocup on July 19, 2009, 04:29:17 pm
Hi ollydbg,

this version is correct and contains for example docu for incremental search etc. The only thing that is missing is the docu for the HexEditor. I will write it as soon as I have some time left.

Title: Re: Update of the CB user manual
Post by: ollydbg on July 19, 2009, 04:40:16 pm
@mariocup

thanks.

I just be serious, I check the PDF property, it said this pdf was created and modified in

2009-02-17 17:51:44. :D

So, I suggest at least, you should add the release data in the front page of this pdf.
Title: Re: Update of the CB user manual
Post by: mariocup on July 19, 2009, 06:28:49 pm
Hi ollydbg,

in the future I plan to use the SVN Revision of the CB trunk repository as document version to see how up to date the document is.

I am interested in your feedback. Perhaps you will find some time to read the document :D

Title: Re: Update of the CB user manual
Post by: blueshake on July 20, 2009, 02:59:30 am
I want to translate the document into Chinese . Anyone want to joint me.
Title: Re: Update of the CB user manual
Post by: ollydbg on July 28, 2009, 03:05:49 pm
Here is my suggestion of improving this user manual.

1, It seems the "screen captured image" was automatically stretched  by latex compiler, so, some images were blur. Eg, fig1.1 should be viewed 200% in the adobe reader :D

2, All paragraphs were stared without empty characters.

3, the new CC branch use different icons for symbols like global define, class...



If it was located in a wiki, I think more people(including me with poor English) can help :D
Title: Re: Update of the CB user manual
Post by: mariocup on July 28, 2009, 03:21:53 pm
Hi ollydbg,

I will add your suggestions at my todo list.

The wiki page is great and gives users an easy way to add information, but when I started with Code::Blocks I noticed that a lot of features (e.g. Block select mode functionality - Using pressed Alt key) had been not so obvious to me. I started the docu to avoid that new users have to collect all the data from the wiki page and starting "spamming" the forum with things that have been answered thousand times. The manual is not intended as replacement of the wiki page.

The manual is written in latex and I am using a few macros in latex, so it is possible also for new users to make a contribution to the docu. If the manual will be included in the CB distribution I expect more feedback to improve it and to see what make sense to document in wiki and what should be included in the CB manual.

Title: Re: Update of the CB user manual
Post by: jens on July 28, 2009, 03:23:02 pm
Here is my suggestion of improving this user manual.

1, It seems the "screen captured image" was automatically stretched  by latex compiler, so, some images were blur. Eg, fig1.1 should be viewed 200% in the adobe reader :D

2, All paragraphs were stared without empty characters.

3, the new CC branch use different icons for symbols like global define, class...



If it was located in a wiki, I think more people(including me with poor English) can help :D

1: no significant difference to other images here (epdfview),

2: I don't get you, what does you mean with this ?

3: as you write, it's the new cc-branch, so it should be changed after a merge, not now.
Title: Re: Update of the CB user manual
Post by: jens on July 28, 2009, 03:26:20 pm
If the manual will be included in the CB distribution I expect more feedback to improve it and to see what make sense to document in wiki and what should be included in the CB manual.

For the debian users: I included it into my nightlies, it can be found in /usr/share/doc/codeblocks/manual_en.pdf.gz
Title: Re: Update of the CB user manual
Post by: ollydbg on July 28, 2009, 03:33:44 pm
Quote
2, All paragraphs were stared without empty characters.
@Jens, sorry for my poor expression. I mean the standard paragraphs should be like below:
Quote
     first paragraphs bla bla bla...
bla bla bla bla bla...
     second paragraphs bla bla bla...
bla bla bla bla bla...
There should be "spaces" before the first line.
Title: Re: Update of the CB user manual
Post by: mariocup on July 28, 2009, 03:35:56 pm
Hi Jens,

we should add also the chm version of the manual and index.ini file in the directory share/codeblocks/docs, then the manual entry will be displayed in the help of Code::Blocks and it becomes more obvious for the users. Since some chm viewer exist under Linux I think this would be reasonable.
Title: Re: Update of the CB user manual
Post by: mariocup on July 28, 2009, 03:37:49 pm
Quote
    first paragraphs bla bla bla...
bla bla bla bla bla...
     second paragraphs bla bla bla...
bla bla bla bla bla...

There should be "spaces" before the first line.

This is an option for generation in latex. In German normally you don't have spaces when starting a paragraph, but in english documents it is the normal case. If the user like I can change the layout.
Title: Re: Update of the CB user manual
Post by: jens on July 28, 2009, 04:11:35 pm
Hi Jens,

we should add also the chm version of the manual and index.ini file in the directory share/codeblocks/docs, then the manual entry will be displayed in the help of Code::Blocks and it becomes more obvious for the users. Since some chm viewer exist under Linux I think this would be reasonable.

There are several chm-viewers, but they are not installed by default.
I would prefer to do use a plain html file (or better structure) on linux together with the integrated html-viewer (if that works) or the standard-browser, because chm's are normally native windows files.

And I would also prefer to keep documentation below /usr/share/doc/, because that's the place it belongs to.
It would work, if absolute-paths can beed in index.ini.
I will see if this can be done, if I have some more time.