summaryrefslogtreecommitdiff
path: root/sandbox/mallard/spec/mal_app.xml
blob: 1fe9828c9179ecfd79a95fa2d71466b233b90ea5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
<topic xmlns="http://www.gnome.org/~shaunm/mallard"
       id="mal_app">
<info>
  <link type="guide" xref="mal_inline"/>
  <version number="0.1" date="2007-02-08" status="review"/>
  <credit type="author" name="Shaun McCance" email="shaunm@gnome.org"/>
  <copyright year="2007" name="Shaun McCance"/>
  <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" />
</info>

<title>Application Names</title>

<synopsis><code mime="application/relax-ng-compact-syntax">
mal_app = element app {
  <link xref="mal_inline#simple">mal_inline_simple</link>+
}
</code></synopsis>

<p>The <code>app</code> element marks the human-readable name of an
application.  It should not be used to mark the name of the command
used to run an application; use <code xref="mal_cmd">cmd</code> for
this purpose instead.</p>


<!-- BEGIN processing -->
<section id="processing">
  <title>Processing Expectations</title>

  <p>Application names are usually nouns, and are often a common word
  or phrase that are indicative of their functionality.  Frequently,
  they are simply the name of what the application is.  In English and
  many other languages, the use of an application name in a sentence
  may sound like the author has simply mistakenly omitted an article
  if the application name is not understood to be a title.</p>

  <p>For example, the calculator application that comes with GNOME is
  called <app>Calculator</app>.  If an author were to write <quote>To
  start <app>Calculator</app>…</quote>, then a reader may confuse this
  for <quote>To start the calculator…</quote> with an error.  This is
  even more pronounced in languages like German, where nouns are always
  capitalized.</p>

  <p>For this reason, it is recommended that application names marked
  with the <code>app</code> element are rendered in italics are using
  some other font variation.</p>
</section>
<!-- END processing -->

</topic>