Glossary: Resources and Deliverables added..
[staff/due1/sed-hs15-srs-purple.git] / src / site / apt / format.apt
index e3e31cc..1b96a06 100644 (file)
@@ -8,6 +8,9 @@
 The APT format
 ~~~~~~~~~~~~~~
 
+       [Note:] Complementary information has been added to this document
+                       without specific notice. -- E. Dubuis
+
   In the following section, boxes containing text in typewriter-like font are
   examples of APT source.
 
@@ -232,7 +235,7 @@ Verbatim text contained in list item 2, but not in sub-list item 2
       [[2]] Numbered item 2.
 +-----------------------------------------+
 
-  A numbered list item begins with a label beetween two square brackets. The
+  A numbered list item begins with a label between two square brackets. The
   label of the first item establishes the numbering scheme for the whole list:
 
       [<<<[[1\]\]>>>] Decimal numbering: 1, 2, 3, 4, etc.
@@ -282,31 +285,22 @@ Verbatim
 *** Figure
 ~~~~~~~~~~
 
-+---------------------------+
-[Figure name] Figure caption
-+---------------------------+
++------------+
+[Figure name] Optional caption 
++------------+
 
   A figure block is not indented. It begins with the figure name between
-  square brackets. The figure name is optionally followed by some text: the
-  figure caption.
-
-  The figure name is the pathname of the file containing the figure but
-  without an extension. Example: if your figure is contained in
-  <<</home/joe/docs/mylogo.jpeg>>>, the figure name is
-  <<</home/joe/docs/mylogo>>>.
-
-  If the figure name comes from a relative pathname (recommended practice)
-  rather than from an absolute pathname, this relative pathname is taken to be
-  relative to the directory of the current APT document (a la HTML)
-  rather than relative to the current working directory.
-
-  Why not leave the file extension in the figure name? This is better
-  explained by an example. You need to convert an APT document to PostScript
-  and your figure name is <<</home/joe/docs/mylogo>>>. A APT processor will
-  first try to load <<</home/joe/docs/mylogo.eps>>>. When the desired format
-  is not found, a APT processor tries to convert one of the existing
-  formats. In our example, the APT processor tries to convert
-  <<</home/joe/docs/mylogo.jpeg>>> to encapsulated PostScript.
+  square brackets. The optional caption generates an <<<alt>>> attribute
+  in the generated HTML <<<img>>> tag containing the caption text.
+
+  The figure name is the pathname of the file containing the figure including
+  its extension. Example: If your figure is contained in file
+  <<<src/site/resources/images/fig_example.svg>>>, the figure name is
+  <<<images/fig_example.svg>>>. Here, <<<src>>> denotes the source
+  directory from within your project directory.
+
+[images/fig_example.svg]Sample use case diagram.
+
 
 *** Table
 ~~~~~~~~~