atom feed74 messages in org.oasis-open.lists.docbookRe: [docbook] Add topic element to Do...
FromSent OnAttachments
Norman WalshOct 26, 2006 5:59 am.pgp
Michael(tm) SmithOct 26, 2006 6:46 am.pgp
Norman WalshOct 26, 2006 7:33 am.pgp
Michael(tm) SmithOct 26, 2006 8:25 am.pgp
Steve CogornoOct 26, 2006 8:51 am 
Norman WalshOct 26, 2006 9:32 am.pgp
Michael(tm) SmithOct 26, 2006 10:17 am.pgp
Yang Tj-ATY010Oct 26, 2006 10:27 am 
Chris ChiassonOct 26, 2006 11:25 am 
Johnson, EricOct 26, 2006 11:40 am 
Sean WhellerOct 26, 2006 12:06 pm 
Melanie KendellOct 26, 2006 4:51 pm 
Johnson, EricOct 26, 2006 5:05 pm 
Michael(tm) SmithOct 26, 2006 10:02 pm.bin
Michael(tm) SmithOct 26, 2006 10:15 pm.bin
Michael(tm) SmithOct 26, 2006 10:17 pm.bin
Michael(tm) SmithOct 26, 2006 10:25 pm.bin
Chris ChiassonOct 26, 2006 10:28 pm 
Michael(tm) SmithOct 26, 2006 10:38 pm.pgp
dougOct 26, 2006 11:32 pm 
Michael(tm) SmithOct 26, 2006 11:51 pm.bin
dougOct 27, 2006 12:19 am 
Camille BégnisOct 27, 2006 1:22 am 
Elliotte HaroldOct 27, 2006 4:47 am 
Michael(tm) SmithOct 27, 2006 5:07 am.bin
Sean WhellerOct 27, 2006 5:24 am 
Michael(tm) SmithOct 27, 2006 5:26 am.bin
Norman WalshOct 27, 2006 5:26 am.pgp
Norman WalshOct 27, 2006 5:39 am.pgp
Norman WalshOct 27, 2006 5:48 am.pgp
Michael(tm) SmithOct 27, 2006 6:53 am.bin
Jirka KosekOct 27, 2006 6:59 am.bin
Michael(tm) SmithOct 27, 2006 7:28 am.bin
Johnson, EricOct 27, 2006 8:15 am 
Rajal ShahOct 27, 2006 8:32 am 
Johnson, EricOct 27, 2006 8:45 am 
Chris ChiassonOct 27, 2006 8:50 am 
Rajal ShahOct 27, 2006 9:02 am 
Chris ChiassonOct 27, 2006 9:12 am 
Rowland, LarryOct 27, 2006 9:35 am 
Rajal ShahOct 27, 2006 9:35 am 
Dan SandersonOct 27, 2006 9:37 am 
Chris ChiassonOct 27, 2006 9:42 am 
Norman WalshOct 27, 2006 9:58 am.pgp
Elliotte HaroldOct 27, 2006 10:06 am 
Dave PawsonOct 27, 2006 10:13 am 
Chris ChiassonOct 27, 2006 10:13 am 
Steven CogornoOct 27, 2006 10:21 am 
Steven CogornoOct 27, 2006 10:36 am 
Eve L. MalerOct 27, 2006 10:47 am 
Bob StaytonOct 27, 2006 10:54 am 
Bob StaytonOct 27, 2006 11:02 am 
Bob StaytonOct 27, 2006 11:28 am 
Steven CogornoOct 27, 2006 11:29 am 
Steven CogornoOct 27, 2006 11:45 am 
Chris ChiassonOct 28, 2006 12:09 pm 
Michael(tm) SmithOct 28, 2006 12:09 pm.bin
Rowland, LarryOct 28, 2006 12:09 pm 
Steve WhitlatchOct 28, 2006 12:09 pm 
dougOct 28, 2006 12:10 pm 
Elliotte HaroldOct 28, 2006 12:11 pm 
Chris ChiassonOct 28, 2006 1:18 pm 
Jirka KosekOct 28, 2006 1:48 pm.bin
Michael(tm) SmithOct 28, 2006 5:24 pm.bin
Elliotte HaroldOct 28, 2006 5:48 pm 
Jirka KosekOct 29, 2006 3:01 am.pgp
Elliotte HaroldOct 29, 2006 3:17 am 
Jirka KosekOct 29, 2006 3:47 am.pgp
Chris ChiassonOct 29, 2006 9:07 am 
Elliotte HaroldOct 29, 2006 10:55 am 
Bob StaytonOct 29, 2006 11:16 am 
Steven CogornoOct 29, 2006 2:13 pm 
Sean WhellerOct 29, 2006 11:30 pm 
Jirka KosekOct 30, 2006 12:07 am.pgp
Subject:Re: [docbook] Add topic element to DocBook?
From:Chris Chiasson (chr@chiasson.name)
Date:Oct 26, 2006 11:25:52 am
List:org.oasis-open.lists.docbook

I think I missed something. What does <topic> better allow the author to express semantically than <section> or <chapter>?

On 10/26/06, Norman Walsh <nd@nwalsh.com> wrote:

We've talked about adding some sort of topic element to DocBook for almost a decade, off and on. (Back at least as far as the days when Novell was an active participant in the Davenport Group.)

The DITA folks make a lot of marketing hay out of their conceptual use of topics. I don't think there's a single, solitary technical advantage to DITA, but marketing doesn't depend on technical accuracy. It's also possible to argue that task-based authoring is not a good idea in general. It's ideal in some circumstances, but results in less useful and less usable documentation in other circumstances.

However, DocBook has never been principally about imposing a particular documentation style on authors. For the most part, we leave stylistic choices to authors.

With this in mind, I think we should consider, perhaps once and for all, whether we want to add a <topic> element to DocBook.

If we decide to do so, I think something along the following lines fits into the design of DocBook:

1. Add a <topic> element with the same content model as <section> except that where section allows (sect1|section|simplesect), we allow <topic>. So a topic contains subtopics analagous to the way a section contains subsections.

2. Give topic a class attribute so that authors can have different kinds of topics. DITA has all this funky weirdness about the content models of various kinds of topics; I don't think we should go there.

3. Allow topic as an alternative to (chapter|appendix|preface) in books. This allows one to have a book of topics.

4. Allow topic as an alternative to (sect1|section|simplesect) in chapters and appendixes. This allows one to have a chapter of topics.

As a slight extension of this model, we could also add a <tasktopic> element. This would address the feature request[1] for "task" as a peer to "section". If we did this, then I'd expect "topic" or "tasktopic" to be allowed anywhere I've mentioned topic above.

Given that topics are often composed in a fairly arbitrary order for publishing in print, we might want to consider adding a "contentmap" element as well for describing the order of topics. But we might be able to get "toc" to serve this purpose.

Be seeing you, norm