[kde-doc-english]Kate Documentation

Frederik Fouvry fouvry at CoLi.Uni-SB.DE
Mon Feb 25 11:47:23 CET 2002


| Could there be an entity &Perl;? I would add this myself, but I'm not sure 
| whether to use <application> or <acronym>, both of which are appropriate, I 
| suppose. Also for other programming languages, how should they be marked up 
| (if at all)? I guess some may be trademarks, but that aside, is <application> 
| appropriate?

This is a tricky issue without one single solution.  As you say,
some names are trademarks.  In some cases, they should be
<command> (depends on context).  <application> should not be
used: (from the Duck Book)

      The appelation "application" is usually reserved for larger
      software packages-WordPerfect, for example, but not
      grep. In some domains, Application may also apply to a
      piece of hardware.

I don't think acronym is meaningful in this context: acronyms
like Perl are usually specially constructed to find a name in the
first place (C++ is even a piece of code).  A "real" acronym is a
by-product of a name (e.g. "UK", "HTML"), and needs to be marked
up just because of this reason.  True, it's not an easy guideline
and prone to disagreement.

That is independent of the definition of an entity though.  To
begin with, it could just contain the string "Perl".  If anything
is added later (say a link to man pages), that can be done easily
because of the entity.  If you really want some markup in it, you
could use <systemitem> with an appropriate role attribute value.

Frederik



More information about the kde-doc-english mailing list