RE: [dita] Product names and reuse

From
Amber Swope <>
Date
2013-01-15T23:36:22+00:00
ID
[email protected]
Thread
RE: [dita] Product names and reuse
Hi there,

 

I encounter these issues with almost every client I support and wanted to “vote” for the importance of a solution for this. I’m sorry that I was unable to attend the meeting this morning, but have read the minutes and see that there isn’t any easy answer. If there is another call about this subject, I will try to attend. 

 

Thanks,

Amber

 

Amber Swope

dita specialist

<dita strategies>

503.922.3038



 

 

 

From:  [mailto:] On Behalf Of Kristen James Eberlein
Sent: Monday, January 14, 2013 10:43 AM
To: DITA TC
Subject: [dita] Product names and reuse

 

A thread about difficulty in reusing products names has cropped up on the dita-users list.

Problem descriptions
1) Information architects or editors design a reuse strategy that revolves around using the <ph> element to hold product names. They then discover that they cannot put a <ph> element within any of the following elements:

<uicontrol>

<wintitle>

2) Another team decides to use <keyword> to hold their product names -- better choice -- but they also discover that they cannot put a keyword element within a <wintitle> element; they have to duplicate their product names within <text> elements for use within <wintitle> elements. And the <tm> element is not available within <text>.

3) Yet another team is stymied because their product name contains typographic formatting (superscript, subscript, bold or italic formatting, an inline image) that cannot be contained in either the <keyword> or <text> element. And while the text element can nest, the @outputclass attribute is not available.

Architects and the writers are caught between a strong desire to reuse content and ensure that product names are consistently used, and a need to have their company's name render correctly.

Thoughts about how we might try to address this problem? And sense about how big (or small) this problem is?

-- 
Best,
Kris

Kristen James Eberlein
Principal consultant, Eberlein Consulting
Co-chair, OASIS DITA Technical Committee
Charter member, OASIS DITA Adoption Committee
www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)

--------------------------------------------------------------------- To unsubscribe from this mail list, you must leave the OASIS TC that generates this mail. Follow this link to all your TCs in OASIS at: https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php