This is the mail archive of the docbook@lists.oasis-open.org mailing list for the DocBook project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: marking up keycaps according to their semantics


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

/ Tobias Reif <tobiasreif at pinkjuice dot com> was heard to say:
|> But the truth of the matter is, I'm not sure this information is worth
|> marking up in this level of detail. I'd probably use something much simpler.
|
| I think that it's great if there's the possibility to do it in a
| simple way, but also go with very granular and detailed markup if
| that's needed.

I was implicitly saying that I don't generally see value in trying to
capture that level of detail.

|> What if you want to do something more interesting, like test your
|> source to make sure the quick reference includes all the keyboard
|> commands actually used.
|
| This requires that the testing tools knows what markup to expect for
| control, alt, etc. Otherwise, it has to be told that in this document,
| "Ctrl" stands for control input, but in this other doc, "C" stands for
| control input. As soon as this tool gets fed a third document, it
| might not work, since it might use "Strg".

It only works if documents are consistently marked up.

|> Well, I think I'd be tempted to recognize <keycap>Ctrl</keycap>
|
| What if authors used "C-" (Emacs notation) or "Strg" (German key
| label) or "<C->" (Vim notation)? What if this tool is to be general,
| and has gets fed something other than <keycap>Ctrl</keycap> for
| control?

It only works if documents are consistently marked up. :-)

|> and
|> translate it directly into another language without adding more markup
|> to make it more "semantic".
|
| I see the latter as necessity. DocBook is mostly (should be 100% IMHO)
| about nothing but about being semantic. If I could markup input as

Right. But there's a constant tension between ease of markup and
granularity of information.

                                        Be seeing you,
                                          norm

- -- 
Norman Walsh <ndw at nwalsh dot com>      | You cannot step twice into the
http://www.oasis-open.org/docbook/ | same river, for other waters are
Chair, DocBook Technical Committee | continually flowing in.--Heraclitus
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (GNU/Linux)
Comment: Processed by Mailcrypt 3.5.7 <http://mailcrypt.sourceforge.net/>

iD8DBQE+ZqlrOyltUcwYWjsRAoJ0AJ9JaA8q4Qising5fPfnCF97Q1aN2gCgj9rR
u32/yzHMFQNkYtStypUZOgo=
=xezi
-----END PGP SIGNATURE-----


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]