OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

dita message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Re: [dita] Product names and reuse


Thanks for chiming in on this, Amber and Scott.

We did have a good discussion on this at today's meeting, but yes, there is no easy answer. (This reminds me of "Yes, we have no bananas ...") We really are limited as to what we can do in DITA 1.x family of releases:
  • We could add <tm> to <text>
  • We could add <tm> to <wintitle>
  • We could add the @outputclass attribute to <text> -- although not a lot of support for this

And I don't think these modifications really would address the issue, although they might enable better specialization or enable some hacks.

Amber and Scott, what issues do you most encounter? At this point, this breaks down in my mind into two issues:

  1. Lack of a single DITA element that can be used to hold product names, that is, the need to use both <keyword> and <text>.
  2. Lack of ability to add formatting information to product names

Am I missing anything?

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)

On 1/15/2013 6:36 PM, Amber Swope wrote:

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

amber@ditastrategies.com

 

 

From: dita@lists.oasis-open.org [mailto:dita@lists.oasis-open.org] 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




[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]