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

 


Help: OASIS Mailing Lists Help | MarkMail Help

dita-help message

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


Subject: RE: [dita-help] Current best practices for context hooks


Now that's an interesting question. We had not considered using the resourceid in topicmeta. A reason I can think of to do that is if your publishing needs would work more efficiently with that information being in the map. For example, if you are creating a mapping between help IDs and dialog box IDs in the application or something as part of the process and starting with a map structure helped that along. Or if you are reusing your help topics in different contexts where the resourceid might change based on the map where the topic is referenced. Or because it is more efficient to manage the IDs in a single map than a mass of topics.

Having the resourceid live in the topic might make sense if you know that resourceid will always be the same and unique to the topic. But in that case, why not use the actual topic id instead and make sure it is unique? I'm not seeing a lot of benefit to having the resourceid in the topic, unless that helps your publishing or authoring process work more efficiently for some reason.

Regards.

Chris


-----Original Message-----
From: Kristen Eberlein [mailto:keberlein@sdl.com] 
Sent: Friday, January 07, 2011 7:08 AM
To: tself@hyperwrite.com; dita-help@lists.oasis-open.org
Cc: Ymte Westra
Subject: RE: [dita-help] Current best practices for context hooks

Hi, Tony.

What do you see as the pros and cons for using the <resourceid> element in the DITA map? In the DITA topics?

Many thanks!

Best regards,
Kris

Kristen James Eberlein l DITA Architect and Technical Specialist l SDL Structured Content Technologies Division l (t) + 1 (919) 682-2290 l keberlein@sdl.com
 
Please consider the environment before printing this e-mail




-----Original Message-----
From: Tony Self [mailto:tself@hyperwrite.com] 
Sent: Friday, January 07, 2011 5:51 AM
To: Kristen Eberlein; dita-help@lists.oasis-open.org
Cc: Ymte Westra
Subject: RE: [dita-help] Current best practices for context hooks

Hi Kris

Like Chris, I use the resourceid element, but in the ditamap, and for
Microsoft HTML Help output. I use the htmlhelp2 or htmlhelp+ plug-ins to the
OT (developed by Deb Pickett). Those plug-ins convert the resourceid
contents to HTML Help alias and map files.

Tony Self


-----Original Message-----
From: Goolsby, Chris [mailto:cgoolsby@ptc.com] 
Sent: Friday, 7 January 2011 2:13 AM
To: Kristen Eberlein; dita-help@lists.oasis-open.org
Cc: Ymte Westra
Subject: RE: [dita-help] Current best practices for context hooks

Yes, we assign a help ID to the <resourceid>, such as "help17074". When we
publish the DITA to HTML, the stylesheet takes the value in <resourceid> and
passes it to a <meta> tag inside of the published HTML chunk for the topic.
The application calls the right topic based on the help ID value in the
<meta> tag.

Chris

-----Original Message-----
From: Kristen Eberlein [mailto:keberlein@sdl.com] 
Sent: Thursday, January 06, 2011 9:57 AM
To: Goolsby, Chris; dita-help@lists.oasis-open.org
Cc: Ymte Westra
Subject: RE: [dita-help] Current best practices for context hooks

Hi, Chris.

So you are adding the <resourceid> element to the <prolog> element within
the DITA topic?

Best regards,

Kris
Kristen James Eberlein l DITA Architect and Technical Specialist l SDL
Structured Content Technologies Division l (t) + 1 (919) 682-2290 l
keberlein@sdl.com
 
Please consider the environment before printing this e-mail




-----Original Message-----
From: Goolsby, Chris [mailto:cgoolsby@ptc.com] 
Sent: Thursday, January 06, 2011 9:36 AM
To: Kristen Eberlein; dita-help@lists.oasis-open.org
Cc: Ymte Westra
Subject: RE: [dita-help] Current best practices for context hooks

At PTC Arbortext, we use the resourceid in topics to hold our context hooks.
The stylesheet passes the value in the resourceid to the published HTML, and
the product grabs the right topic based on that value.

Regards.

Chris Goolsby
PTC

-----Original Message-----
From: Kristen Eberlein [mailto:keberlein@sdl.com] 
Sent: Thursday, January 06, 2011 9:29 AM
To: dita-help@lists.oasis-open.org
Cc: Ymte Westra
Subject: [dita-help] Current best practices for context hooks

What are people currently doing for context hooks? SDL has some clients who
cannot wait for DITA 1.3; any current best practices that we should
practice?

Best regards,
Kris

Kristen James Eberlein l DITA Architect and Technical Specialist l SDL
Structured Content Technologies Division l (t) + 1 (919) 682-2290 l
keberlein@sdl.com
 
Please consider the environment before printing this e-mail


-----Original Message-----
From: Tony Self [mailto:tself@hyperwrite.com] 
Sent: Monday, December 06, 2010 1:33 AM
To: dita-help@lists.oasis-open.org
Subject: [dita-help] Help Features in DITA 1.3

Greetings colleagues

Now that 1.2 has been released, we have to start thinking about 1.3. You
will probably recall that the Help Subcommittee was established to make
recommendations for 1.3; it wasn't anticipated that 1.3 would be so far
away.

So far, we have proposals for spec changes to better handle context hooks,
and window definitions. 

We have discussed in the past the possibility of a specialisation for
integrated or embedded user assistance content.

There has been some negative feedback from the community about the perceived
complexity of 1.2, with new information types, constrained versions of some
types, and a (perceived) mushrooming in the number of elements. 

My feeling is that the context hook and window definitions should be built
into the base content model. My feeling is that we should not have a
specialised information type for UA, mainly because I don't think the
community is demanding such a thing.

What do you all think? 

Tony Self



---------------------------------------------------------------------
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 


---------------------------------------------------------------------
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 


---------------------------------------------------------------------
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 


---------------------------------------------------------------------
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]