issue-#100 Improve documentation for Converters

[DGDanforth]

So Josef and Ivan,
Who wants to change the documentation for Converters?
I do not know yet how to use Redmine to make those changes.
-Doug

[Ivan Denisov]

I have made branch 100 again and add this fix in the Converters docu.
http://redmine.blackboxframework.org/pr ... db9724538d

[DGDanforth]

I have made branch 100 again and add this fix in the Converters docu.
http://redmine.blackboxframework.org/pr ... db9724538d

Ivan,
Thank you.
The module Config should be discussed and have its own document.
-Doug

[Ivan Denisov]

The module Config should be discussed and have its own document.

I agree. Maybe you can prepare some draft?

[Zinn]

I prefer to left in the sentence about Config. You may add it add the end of your changed text:

You may use the Config module. Config is executed upon startup of BlackBox to allow the establishment of custom configurations, such as the set of available converters.

- Helmut

[DGDanforth]

I just did a search through the master documentation for both both "Config" and "Converters" and found 4 files that also need modification
so as not to mislead the reader.

DevBrowser
ObxConv
StdETHConv
XhtmlExporter

The changes need to direct the reader away from the Config file and emphasize the converters can be registered by any module.

[Josef Templ]

I agree with Helmut. This change removes important information.

There is no need to emphasize that an exported procedure can be called from another module.
Where else should it be called?

What needs to be emphasized is the same as in the BB1.6 docu but in a different wording.
It is the fact that converters that are to be available at startup of BB need to be installed
such that they are available automatically and this is what Config.Setup is used for.
The misleading part (at least for some) is that one may think that this is the only place.

My proposal would be this:

The standard document converter is already installed by the BlackBox core. Converters that should be available after startup of BlackBox should be registered in the Config module, e.g., converters for ASCII files, Unicode files, or picture files. Config.Setup is executed upon startup of BlackBox to allow the establishment of custom configurations, such as the set of available converters.


+ What are the changes in Tut-1 and Tut-2?

+ The commit message has a typo: coverters

- Josef

[DGDanforth]

I agree with Helmut. This change removes important information.

There is no need to emphasize that an exported procedure can be called from another module.
Where else should it be called?

Where ever one wants it.
When I begin working on a project that requires Coco I do an install (pull down menu option).

What needs to be emphasized is the same as in the BB1.6 docu but in a different wording.
It is the fact that converters that are to be available at startup of BB need to be installed
such that they are available automatically and this is what Config.Setup is used for.

agreed

The misleading part (at least for some) is that one may think that this is the only place.

agreed

My proposal would be this:

The standard document converter is already installed by the BlackBox core. Converters that should be available after

change "after" to "at"

startup of BlackBox should be registered in the Config module, e.g., converters for ASCII files, Unicode files, or picture files. Config.Setup is executed upon startup of BlackBox to allow the establishment of custom configurations, such as the set of available converters.


+ What are the changes in Tut-1 and Tut-2?

+ The commit message has a typo: coverters

- Josef

[Ivan Denisov]

Folks, can you please prepare files which need to be changed.
I really get mixed up with your instructions

[Josef Templ]

I will try to finish it.