Dr. Yves Forkl wrote:
> Hussein Shafie wrote:
>> On 02/21/2011 05:11 PM, Dr. Yves Forkl wrote:
>>> [...] I know I can disable the check interactively via "Help |
>>> Check for Updates" and unchecking (sorry for the pun) of
>>> "Automatically check for updates". [...]
>> This preference key is documented in the "Help menu" section. See 
>> http://www.xmlmind.com/xmleditor/_distrib/doc/help/helpMenu.html
> 
> Thank you for pointing me to this page, which I should have looked at in the 
> fist place, of course.
> 
> Given that the properties for preferences are explained in the documentation 
> of the respective menus only, the page about the command line options 
> -putpref and -putprefs [1] should include a link to each of these pages. 
> Currently, that page only links to the "Preferences dialog box" page [2], but 
> would also need to link to the "Help menu" page (and maybe other pages?).
> 
> In the long run, it could be useful to document all of the preference 
> properties in a reference page of its own, similar to the command reference, 
> and to just put a link to this page at the place where command line options 
> -putpref and -putprefs are documented.
> 

You are right, of course. It's never a good idea to mix the
documentation which targets the author (menus, dialogs, etc) and the
documentation which targets the XML consultant (preference keys).




> Best,
> 
>   Yves
> 
> [1] http://www.xmlmind.com/xmleditor/_distrib/doc/help/command_line_usage.html
> [2] 
> http://www.xmlmind.com/xmleditor/_distrib/doc/help/com.xmlmind.guiutil.PreferencesEditorDialog.html
>  
 
--
XMLmind XML Editor Support List
[email protected]
http://www.xmlmind.com/mailman/listinfo/xmleditor-support

Reply via email to