Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redundant doc type settings descriptions #43

Open
mbakeranalecta opened this issue Aug 27, 2014 · 3 comments
Open

Redundant doc type settings descriptions #43

mbakeranalecta opened this issue Aug 27, 2014 · 3 comments
Labels

Comments

@mbakeranalecta
Copy link
Contributor

There are two complete sets of descriptions for the document type associations/frameworks configuration, one in the Authoring Customization Guide (http://www.oxygenxml.com/doc/ug-editor/index.html#topics/dg-author-settings.html) and one in the Configuration chapter (http://www.oxygenxml.com/doc/ug-editor/index.html#topics/preferences-document-type-association.html). As far as I can tell, there is little or no reuse between the two sections. The version in the Authoring Customization Guide seems to be more extensive.

While it is presented as part of the Advance tutorial, the version in the Customization Guide is not actually tutorial in nature. That is, it does not step the reader through a particular project step by step. That does not start until http://www.oxygenxml.com/doc/ug-editor/index.html#topics/dg-basic-association.html.

Since the Customization Guide is now part of the Editor Guide, there is no need for it to have its own version of the configuration material, which is essentially reference material.Removing it will make it easier for people to find and follow the tutorials, which can link to the configuration reference material as needed.

My proposal is to merge the material form the Customization Guide into the Configuration chapter.

Is there anything I should know about why there were two separate sets of topics on Document Type Associations that might affect this decision?

@raducoravu
Copy link
Contributor

I might be wrong, this is what I remember on the subject:

Initially the "preferences-document-type-association.html" which describes the Document Type Association Preferences Page was almost empty and pointed to the other chapter from the Customization Guide "dg-author-settings.html".

This was kind of wrong because "dg-author-settings.html" goes into too much tutorial details and we just needed a topic which simply describes the preferences page and what each tab from the "Document Type Edit Dialog" does without going into too much details.

About this suggestion:

My proposal is to merge the material form the Customization Guide into the Configuration chapter. 

If the Author SDK would be a separate built target, this would be a problem because it would need to be self contained in its DITA Map without references to preference pages.
If the Author SDK ceases to be a separate build target and users of the Author SDK just get a link to a certain Web page from the Oxygen XML Editor user's manual (instead of a PDF containing only the Author SDK stuff) this could work.

@georgebina
Copy link
Contributor

I think issue 30 suggests removing this information from the preferences and putting it in a chapter. Shall we close this then as invalid?

@mbakeranalecta
Copy link
Contributor Author

If we accept the suggestion in issue 30, then yes, this issue is redundant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants