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

Thank you very much, sir!

It is very much a work in progress, and I would be surprised if I have any substantial for people to look at before the end of the year. When it gets closer to completion, I will check in with you about having it translated.

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

Hi Keith,

I haven’t done much in previous year (InfoParse fiscal). I volunteer to do Japanese translation since I have been pushing keys in general.

Cheers,

-Tetsuya/InfoParse

From: dita-adoption@lists.oasis-open.org [mailto:dita-adoption@lists.oasis-open.org] On Behalf Of Keith Schengili-Roberts
Sent: Tuesday, October 2, 2018 1:02 AM
To: dita-adoption@lists.oasis-open.org
Subject: [dita-adoption] Rough Outline for Keys Whitepaper

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