issue-#100 Improve documentation for Converters

User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

issue-#100 Improve documentation for Converters

Post by 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
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

Re: Converters

Post by Ivan Denisov »

I have made branch 100 again and add this fix in the Converters docu.
http://redmine.blackboxframework.org/pr ... db9724538d
User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

Re: Converters

Post by DGDanforth »

Ivan Denisov wrote: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
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

Re: Converters

Post by Ivan Denisov »

DGDanforth wrote:The module Config should be discussed and have its own document.
I agree. Maybe you can prepare some draft?
Zinn
Posts: 476
Joined: Tue Mar 25, 2014 5:56 pm
Location: Frankfurt am Main
Contact:

Re: Converters

Post by 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
User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

Re: Converters

Post by 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.
User avatar
Josef Templ
Posts: 2047
Joined: Tue Sep 17, 2013 6:50 am

Re: Converters

Post by 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
User avatar
DGDanforth
Posts: 1061
Joined: Tue Sep 17, 2013 1:16 am
Location: Palo Alto, California, USA
Contact:

Re: Converters

Post by DGDanforth »

Josef Templ wrote: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).
Josef Templ wrote: 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
Josef Templ wrote: The misleading part (at least for some) is that one may think that this is the only place.
agreed
Josef Templ wrote: 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"
Josef Templ wrote: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
Posts: 1700
Joined: Tue Sep 17, 2013 12:21 am
Location: Russia

Re: issue-#100 Improve documentation for Converters

Post by Ivan Denisov »

Folks, can you please prepare files which need to be changed.
I really get mixed up with your instructions :)
User avatar
Josef Templ
Posts: 2047
Joined: Tue Sep 17, 2013 6:50 am

Re: issue-#100 Improve documentation for Converters

Post by Josef Templ »

I will try to finish it.
Post Reply