[oXygen-user] Linking uicontrol with a collection topic

[KAATMAN Matthew]

Thanks for all these great ideas Radu! I'm going to try the schematron route first. That seems like it will give them the flexibility of using uicontrol as they need to but also warn them about any instances that aren't conkeyrefed.

Thanks!
Matt

-----Original Message-----
From: oxygen-user-bounces at oxygenxml.com [mailto:oxygen-user-bounces at oxygenxml.com] On Behalf Of Oxygen XML Editor Support
Sent: Friday, October 04, 2013 3:11 AM
To: oxygen-user at oxygenxml.com
Subject: Re: [oXygen-user] Linking uicontrol with a collection topic

Hi Matt,

Here are some possibilities:

1) In the Oxygen Preferences->"Document Type Association" page you can edit the DITA document type. In the "Author" tab you select the "Content Completion" tab. This tab has a "Filter - Remove content completion items" list to which you can add <uicontrol>.
Then the same tab has a list of "Content Completion" extensions, actions, which appear in the content completion window.
You could add to that list the "insert.conkeyref" action with a display name of <uicontrol>.
The final result would be that when the tech writer selects <uicontrol> in the content completion window the dialog for inserting conkeyrefs will appear. This will work only in the Author visual editing mode.

2) Instead of disallowing the writers to enter <uicontrol> with custom text you could have a Schematron file which checks that all <uicontrol> elements have the @conkeyref attribute on them. The Schematron content would be like:

> <schema xmlns="http://purl.oclc.org/dsdl/schematron" queryBinding="xslt2">
>     <pattern>
>         <rule context="*[contains(@class, ' ui-d/uicontrol ')] ">
>             <assert test="@conkeyref">UI Control must have a conkeyref to our reusable snippets.</assert>
>         </rule>
>     </pattern>
> </schema>

You could use the Schematron in two ways:

a) The "Validate and check for completeness" action available on the DITA Maps Manager toolbar allows you to set an "Additional Schematron checks" file. In this way, from time to time you could check the entire project.

b) Add the pattern from the schematron snippet above directly in the Schematron file:

OXYGEN_INSTALL_DIR\frameworks\dita\resources\dita-1.2-for-xslt2-mandatory.sch

which is used to validate all edited DITA topics. Or of course, modify the DITA document type and edit the default validation scenario to include another Schematron-based validation unit.


There is also the additional idea of automatically generating code templates for each possible conkeyref value and add them to the content completion list, I proposed the idea on the DITA Users List a while ago along with an XSL stylesheet:

http://groups.yahoo.com/neo/groups/dita-users/conversations/messages/32818

Regards,
Radu

Radu Coravu
<oXygen/>  XML Editor, Schema Editor and XSLT Editor/Debugger http://www.oxygenxml.com

On 10/3/2013 11:14 PM, KAATMAN Matthew wrote:
> I have a topic with a collection of uicontrol elements. I generate this topic from a java properties file for software strings using a script I wrote.
>
> Is there any way for me to force the writers to conkeyref to this file anytime they add a uicontrol?
>
> Or even if Oxygen could push them towards using conkeyref instead of entering text directly, that might be sufficient to remind them of what they need to do.
>
> I can't think of a practical way to make this happen (and maybe it's even too rigid to be practical) but I thought I'd ask and see if anyone had ideas.
>
> Thanks,
> Matt
>
> AVIS : Ce courrier et ses pieces jointes sont destines a leur seul destinataire et peuvent contenir des informations confidentielles appartenant a bioMerieux. Si vous n'etes pas destinataire, vous etes informe que toute lecture, divulgation, ou reproduction de ce message et des pieces jointes est strictement interdite. Si vous avez recu ce message par erreur merci d'en prevenir l'expediteur et de le detruire, ainsi que ses pieces jointes.
> NOTICE: This message and attachments are intended only for the use of their addressee and may contain confidential information belonging to bioMerieux. If you are not the intended recipient, you are hereby notified that any reading, dissemination, distribution, or copying of this message, or any attachment, is strictly prohibited. If you have received this message in error, please notify the original sender immediately and delete this message, along with any attachments.
>
>
> _______________________________________________
> oXygen-user mailing list
> oXygen-user at oxygenxml.com
> http://www.oxygenxml.com/mailman/listinfo/oxygen-user
>
_______________________________________________
oXygen-user mailing list
oXygen-user at oxygenxml.com
http://www.oxygenxml.com/mailman/listinfo/oxygen-user

AVIS : Ce courrier et ses pieces jointes sont destines a leur seul destinataire et peuvent contenir des informations confidentielles appartenant a bioMerieux. Si vous n'etes pas destinataire, vous etes informe que toute lecture, divulgation, ou reproduction de ce message et des pieces jointes est strictement interdite. Si vous avez recu ce message par erreur merci d'en prevenir l'expediteur et de le detruire, ainsi que ses pieces jointes.
NOTICE: This message and attachments are intended only for the use of their addressee and may contain confidential information belonging to bioMerieux. If you are not the intended recipient, you are hereby notified that any reading, dissemination, distribution, or copying of this message, or any attachment, is strictly prohibited. If you have received this message in error, please notify the original sender immediately and delete this message, along with any attachments.