Re: [dita-adoption] Rough Outline for Keys Whitepaper

[Kristen James Eberlein <kris@eberleinconsulting.com>]

Keith, is the intent for the white paper to build on the original Adoption TC white paper about keys?

Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)

On 10/1/2018 12:01 PM, Keith Schengili-Roberts wrote:

Here's what I had in mind as a rough ToC for this:

Introduction
- About the source document
- Code samples

An introduction to keys
- A brief history of keys
- Key basics
- Advantages of keys
- Parts of a key
- Keys vs. variables
- Defining keys directly within a map
- Creating a keystore
- Using conkeyref
- Adding keys to topicrefs
- Keys and conditional processing

Advantages of Keys and Best Practices
- How to name your keys
- Working with product keys
- Working with graphics keys
- Working with user interface keys
- Working with Technical data keys
- How and when to best use conkeyref
- Understanding key predence
- Scoped key use for specific-purpose publications

Some references:
"Keys in Action" by Magda Caloian from DITA NA 2018
"Growing up DITA" by Maria Essig from DITA NA 2018
"Keys Applied-Practical Strategies for Designing, Using, and Managing DITA Keys" - Roger Hadley

Cheers!

 

-

Keith Schengili-Roberts

Market Researcher and DITA Evangelist

 

IXIASOFT 

825 Querbes, Suite 200, Montréal, Québec, Canada, H2V 3X1

tel  + 1 514 279-4942  /  toll free + 1 877 279-4942 

robertsk@ixiasoft.com  /  www.ixiasoft.com