OASIS Darwin Information Typing Architecture (DITA) TC

Recently we approved adding the new processing-role attribute, with values
of "normal" and "resource-only", to topicref and its specializations. Use
of processing-role="resource-only" indicates that the target is to be used
only as a resource, without appearing in any generated TOC, not linked to,
not generated as part of PDF/XHTML/whatever other output.

We also have a new 

On 4/21/09 9:44 AM, "Robert D Anderson" 

Adding a default for @processing-role of "resource-only" on keydef seems
like the right thing to do.

There was a to do from the @processing-role discussion to define the
relationship between the new attribute and the older attribures such as
@linking, @print, @search, ....  Was that done?  Is it being done?

What does it mean to say @processing-role="resource-only" @print="yes"?

   -Jeff

> 

                                                

					
                                                    

        
                                                
				
                                                

                                                    
                                                        
                                                        Original Message
                                                
                                                Original Message-----
> From: Robert D Anderson [mailto:robander@us.ibm.com]
> Sent: Tuesday, April 21, 2009 10:45 AM
> To: dita
> Subject: [dita] processing-role attribute
> 
> 
> Recently we approved adding the new processing-role attribute, with
values
> of "normal" and "resource-only", to topicref and its specializations.
Use
> of processing-role="resource-only" indicates that the target is to be
used
> only as a resource, without appearing in any generated TOC, not linked
to,
> not generated as part of PDF/XHTML/whatever other output.
> 
> We also have a new 

I don't have the minutes/discussion in front of me, but I remember hearing
that processing-role would override other values, so that "resource-only"
would keep something out of the TOC; I assume that would also apply to the
print attribute. I don't think that we've seen a summary though to define
how other attributes interact with processing-role.

Robert D Anderson
IBM Authoring Tools Development
Chief Architect, DITA Open Toolkit

"Ogden, Jeff" 

The minutes are included below.

A remaining question is, is there any interaction with attributes other
than toc and print?  @linking and @search come to mind.  Any others?

   -Jeff

From the 17 February DITA TC meeting minutes:

3.  New ITEM: Map structure and possible new attribute for conref push
and anchorref 
    * http://lists.oasis-open.org/archives/dita/200901/msg00034.html
(Su-Laine Yeo, Eliot, Bruce) 
    * http://lists.oasis-open.org/archives/dita/200902/msg00015.html
(Su-Laine's "rebooted" version and ensuing discussion) 
    * http://lists.oasis-open.org/archives/dita/200902/msg00035.html
(apparent latest proposal) 

    > Su-Laine: Robert's roll up is the latest summary of the
discussion. The third link 
    > suggests names.

    > DECISION: attribute name: processing-role
    > DECISION: attribute values: resource-only, normal (default value
is 'normal')

    > Notes:
    > 1. The spec should mention the default behavior.
    > 2. The TC decided that attribute names and values should be
hyphenated in 
    >    the future, as a precedence.
    > 3. Need to address how this attribute interacts with @print=yes or
@toc -- how is 
    > this handled? Processing role should win. (add to processing topic
of arch spec)

    > CLOSED

> 

                                                

					
                                                    

        
                                                
				
                                                

                                                    
                                                        
                                                        Original Message
                                                
                                                Original Message-----
> From: Robert D Anderson [mailto:robander@us.ibm.com]
> Sent: Tuesday, April 21, 2009 11:05 AM
> To: Ogden, Jeff
> Cc: dita
> Subject: RE: [dita] processing-role attribute
> 
> I don't have the minutes/discussion in front of me, but I remember
hearing
> that processing-role would override other values, so that
"resource-only"
> would keep something out of the TOC; I assume that would also apply to
the
> print attribute. I don't think that we've seen a summary though to
define
> how other attributes interact with processing-role.
> 
> Robert D Anderson
> IBM Authoring Tools Development
> Chief Architect, DITA Open Toolkit
> 
> "Ogden, Jeff" 

I've got cascading on the brain and so ...

 

I assume that @processing-role itself does not cascade.

 

But does @processing-role="resource-only" change the cascading
behavior for any other attributes or other properties?

 

Cascading within a map?

Cascading from map to map?

Cascading from map to topic?

 

   -Jeff

 

> 

                                                

					
                                                    

        
                                                
				
                                                

                                                    
                                                        
                                                        Original Message
                                                
                                                Original Message-----


> From: Robert D Anderson [mailto:robander@us.ibm.com]

> Sent: Tuesday, April 21, 2009 10:45 AM

> To: dita

> Subject: [dita] processing-role attribute

> 

> 

> Recently we approved adding the new processing-role attribute,
with values

> of "normal" and "resource-only", to topicref
and its specializations. Use

> of processing-role="resource-only" indicates that the
target is to be used

> only as a resource, without appearing in any generated TOC, not linked
to,

> not generated as part of PDF/XHTML/whatever other output.

> 

> We also have a new <keydef> element as a shortcut for
defining keys in

> DITA

> 1.2. It defaults to toc=no, linking=none, and print=no. So my
question is,

> should it also default to processing-role=resource-only? This
seems

> logical, and in fact seems part of the reason we added
resource-only, but

> I

> don't think it was called out in the original discussion.

> 

> Thanks -

> 

> Robert D Anderson

> IBM Authoring Tools Development

> Chief Architect, DITA Open Toolkit

> 

> 

> ---------------------------------------------------------------------

> 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

 

Actually it could be quite useful for
processing-role to cascade. For example:

Author A creates a single map that defines
both a TOC and the keys for the topicrefs in the TOC (not using keydef
- just a single TOC with a key on each topicref)

Author B wants to reuse a bunch of the
topics but their own nav. So they want to use the key definitions in author
A's map but not the nav structure. So they create a mapref (or a conref
to a subset of the target map) setting processing-role="resourceonly".
 
Michael Priestley, Senior Technical
Staff Member (STSM)

Lead IBM DITA Architect

mpriestl@ca.ibm.com

http://dita.xml.org/blog/25





"Ogden, Jeff"
<jogden@ptc.com> 
04/21/2009 11:12 AM




To
"Robert D Anderson" <robander@us.ibm.com>,
"dita" <dita@lists.oasis-open.org>


cc



Subject
RE: [dita] processing-role attribute
[cascading]






I've got cascading on the brain and
so ...
 
I assume that @processing-role itself
does not cascade.
 
But does @processing-role="resource-only"
change the cascading behavior for any other attributes or other properties?
 
Cascading within a map?
Cascading from map to map?
Cascading from map to topic?
 
   -Jeff
 
> 

                                                

					
                                                    

        
                                                
				
                                                

                                                    
                                                        
                                                        Original Message
                                                
                                                Original Message-----
> From: Robert D Anderson [mailto:robander@us.ibm.com]
> Sent: Tuesday, April 21, 2009
10:45 AM
> To: dita
> Subject: [dita] processing-role
attribute
> 
> 
> Recently we approved adding the
new processing-role attribute, with values
> of "normal" and "resource-only",
to topicref and its specializations. Use
> of processing-role="resource-only"
indicates that the target is to be used
> only as a resource, without appearing
in any generated TOC, not linked to,
> not generated as part of PDF/XHTML/whatever
other output.
> 
> We also have a new <keydef>
element as a shortcut for defining keys in
> DITA
> 1.2. It defaults to toc=no, linking=none,
and print=no. So my question is,
> should it also default to processing-role=resource-only?
This seems
> logical, and in fact seems part
of the reason we added resource-only, but
> I
> don't think it was called out
in the original discussion.
> 
> Thanks -
> 
> Robert D Anderson
> IBM Authoring Tools Development
> Chief Architect, DITA Open Toolkit
> 
> 
> ---------------------------------------------------------------------
> 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
 

Would it always cascade?  Would it cascade
from a keydef? My head is starting to hurt again.

 

   -Jeff

 











From: Michael
Priestley [mailto:mpriestl@ca.ibm.com]

Sent: Tuesday, April 21, 2009
11:23 AM

To: Ogden, Jeff

Cc: dita; Robert D Anderson

Subject: RE: [dita]
processing-role attribute [cascading]



 



Actually it could be quite useful for processing-role
to cascade. For example:


Author
A creates a single map that defines both a TOC and the keys for the topicrefs
in the TOC (not using keydef - just a single TOC with a key on each topicref)


Author
B wants to reuse a bunch of the topics but their own nav. So they want to use
the key definitions in author A's map but not the nav structure. So they create
a mapref (or a conref to a subset of the target map) setting
processing-role="resourceonly".

 

Michael
Priestley, Senior Technical Staff Member (STSM)

Lead IBM DITA Architect

mpriestl@ca.ibm.com

http://dita.xml.org/blog/25





 

  

  
"Ogden, Jeff"
  <jogden@ptc.com> 
  
04/21/2009 11:12 AM 
  
  

  

   

    

    
To
    
    

    
"Robert D Anderson"
    <robander@us.ibm.com>, "dita"
    <dita@lists.oasis-open.org> 
    
   
   

    

    
cc
    
    

    
 
    
   
   

    

    
Subject
    
    

    
RE: [dita] processing-role attribute
    [cascading]
    
   
  
  
 
  
  

  
 






I've got cascading on the brain and so ...

 

I
assume that @processing-role itself does not cascade.

 

But
does @processing-role="resource-only" change the cascading behavior
for any other attributes or other properties?

 

Cascading
within a map?

Cascading
from map to map?

Cascading
from map to topic?

 

 
 -Jeff

 

>


                                                

					
                                                    

        
                                                
				

                                                

                                                    
                                                        
                                                        Original Message
                                                
                                                Original Message-----

>
From: Robert D Anderson [mailto:robander@us.ibm.com]

>
Sent: Tuesday, April 21, 2009 10:45 AM

>
To: dita

>
Subject: [dita] processing-role attribute

>


>


>
Recently we approved adding the new processing-role attribute, with values

>
of "normal" and "resource-only", to topicref and its
specializations. Use

>
of processing-role="resource-only" indicates that the target is to be
used

>
only as a resource, without appearing in any generated TOC, not linked to,

>
not generated as part of PDF/XHTML/whatever other output.

>


>
We also have a new <keydef> element as a shortcut for defining keys in

>
DITA

>
1.2. It defaults to toc=no, linking=none, and print=no. So my question is,

>
should it also default to processing-role=resource-only? This seems

>
logical, and in fact seems part of the reason we added resource-only, but

>
I

>
don't think it was called out in the original discussion.

>


>
Thanks -

>


>
Robert D Anderson

>
IBM Authoring Tools Development

>
Chief Architect, DITA Open Toolkit

>


>


>
---------------------------------------------------------------------

>
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

 

Small point, but in the interests of minimalism... Why not just "resource",
rather than "resource-only"? 



                                                

					
                                                    

        
                                                
				
                                                

                                                    
                                                        
                                                        Original Message
                                                
                                                Original Message-----
From: Robert D Anderson [mailto:robander@us.ibm.com] 
Sent: Tuesday, April 21, 2009 10:45 AM
To: dita
Subject: [dita] processing-role attribute


Recently we approved adding the new processing-role attribute, with values
of "normal" and "resource-only", to topicref and its specializations. Use of
processing-role="resource-only" indicates that the target is to be used only
as a resource, without appearing in any generated TOC, not linked to, not
generated as part of PDF/XHTML/whatever other output.

We also have a new 

Because all referenced files are resources, but this attribute 
indicates that a given referenced file is only a resource, and
is not to be included in the resulting output.

paul

> 

                                                

					
                                                    

        
                                                
				
                                                

                                                    
                                                        
                                                        Original Message
                                                
                                                Original Message-----
> From: Tim Grantham [mailto:tgrantham@timgrantham.com] 
> Sent: Tuesday, 2009 April 21 10:35
> To: 'dita'
> Subject: RE: [dita] processing-role attribute
> 
> Small point, but in the interests of minimalism... Why not 
> just "resource",
> rather than "resource-only"? 
> 
> 
Original Message-----
> From: Robert D Anderson [mailto:robander@us.ibm.com] 
> Sent: Tuesday, April 21, 2009 10:45 AM
> To: dita
> Subject: [dita] processing-role attribute
> 
> 
> Recently we approved adding the new processing-role 
> attribute, with values
> of "normal" and "resource-only", to topicref and its 
> specializations. Use of
> processing-role="resource-only" indicates that the target is 
> to be used only
> as a resource, without appearing in any generated TOC, not 
> linked to, not
> generated as part of PDF/XHTML/whatever other output.
> 
> We also have a new