Intitial project setup.
authorEric Dubuis <eric.dubuis@bfh.ch>
Sat, 3 Oct 2015 06:39:35 +0000 (08:39 +0200)
committerEric Dubuis <eric.dubuis@bfh.ch>
Sat, 3 Oct 2015 06:39:35 +0000 (08:39 +0200)
META-INF/MANIFEST.MF [new file with mode: 0644]
pom.xml [new file with mode: 0644]
src/checkstyle/checkstyle-configuration.xml [new file with mode: 0644]
src/checkstyle/checkstyle-header.txt [new file with mode: 0644]
src/site/apt/format.apt [new file with mode: 0644]
src/site/apt/index.apt [new file with mode: 0644]
src/site/fml/faq.fml [new file with mode: 0644]
src/site/resources/doc/vision.pdf [new file with mode: 0644]
src/site/resources/images/bfh-ti-de.gif [new file with mode: 0644]
src/site/site.xml [new file with mode: 0644]

diff --git a/META-INF/MANIFEST.MF b/META-INF/MANIFEST.MF
new file mode 100644 (file)
index 0000000..5828281
--- /dev/null
@@ -0,0 +1,3 @@
+Manifest-Version: 1.0\r
+Created-By: 1.8.0_31 (Oracle Corporation)\r
+\r
diff --git a/pom.xml b/pom.xml
new file mode 100644 (file)
index 0000000..a71a705
--- /dev/null
+++ b/pom.xml
@@ -0,0 +1,241 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+       <modelVersion>4.0.0</modelVersion>
+       <groupId>srs-sample</groupId>
+       <artifactId>srs-sample-main</artifactId>
+       <version>1.0-SNAPSHOT</version>
+       <name>Smart Reservation System</name>
+       <description>Some description ...</description>
+       <organization>
+               <name>BFH</name>
+       </organization>
+       <url>http://www.bfh.ch</url>
+
+       <properties>
+               <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+       </properties>
+
+       <developers>
+               <developer>
+                       <id>Abbreviation1</id>
+                       <name>FirstName1 Name1</name>
+                       <email>E-Mail Address1</email>
+                       <organization>Berner Fachhochschule / TI</organization>
+                       <organizationUrl>http://www.ti.bfh.ch/</organizationUrl>
+                       <roles>
+                               <role>SCRUM master</role>
+                               <role>software developer</role>
+                       </roles>
+                       <timezone>+1</timezone>
+               </developer>
+               <developer>
+                       <id>Abbreviation2</id>
+                       <name>FirstName2 Name2</name>
+                       <email>E-Mail Address2</email>
+                       <organization>Berner Fachhochschule / TI</organization>
+                       <organizationUrl>http://www.ti.bfh.ch/</organizationUrl>
+                       <roles>
+                               <role>software developer</role>
+                       </roles>
+                       <timezone>+1</timezone>
+               </developer>
+               <developer>
+                       <id>Abbreviation3</id>
+                       <name>FirstName3 Name3</name>
+                       <email>E-Mail Address3</email>
+                       <organization>Berner Fachhochschule / TI</organization>
+                       <organizationUrl>http://www.ti.bfh.ch/</organizationUrl>
+                       <roles>
+                               <role>software developer</role>
+                       </roles>
+                       <timezone>+1</timezone>
+               </developer>
+               <developer>
+                       <id>Abbreviation4</id>
+                       <name>FirstName4 Name4</name>
+                       <email>E-Mail Address4</email>
+                       <organization>Berner Fachhochschule / TI</organization>
+                       <organizationUrl>http://www.ti.bfh.ch/</organizationUrl>
+                       <roles>
+                               <role>software developer</role>
+                       </roles>
+                       <timezone>+1</timezone>
+               </developer>
+       </developers>
+
+       <dependencies>
+               <dependency>
+                       <groupId>junit</groupId>
+                       <artifactId>junit</artifactId>
+                       <version>4.12</version>
+                       <scope>test</scope>
+               </dependency>
+       </dependencies>
+
+       <dependencyManagement>
+               <dependencies>
+                       <dependency>
+                               <groupId>com.zenjava</groupId>
+                               <artifactId>javafx-maven-plugin</artifactId>
+                               <version>8.1.2</version>
+                       </dependency>
+               </dependencies>
+       </dependencyManagement>
+
+       <build>
+               <pluginManagement>
+                       <plugins>
+                               <plugin>
+                                       <groupId>org.jacoco</groupId>
+                                       <artifactId>jacoco-maven-plugin</artifactId>
+                                       <version>0.7.5.201505241946</version>
+                               </plugin>
+                               <!--This plugin's configuration is used to store Eclipse m2e settings 
+                                       only. It has no influence on the Maven build itself. -->
+                               <plugin>
+                                       <groupId>org.eclipse.m2e</groupId>
+                                       <artifactId>lifecycle-mapping</artifactId>
+                                       <version>1.0.0</version>
+                                       <configuration>
+                                               <lifecycleMappingMetadata>
+                                                       <pluginExecutions>
+                                                               <pluginExecution>
+                                                                       <pluginExecutionFilter>
+                                                                               <groupId>org.jacoco</groupId>
+                                                                               <artifactId>
+                                                                                       jacoco-maven-plugin
+                                                                               </artifactId>
+                                                                               <versionRange>
+                                                                                       [0.7.5.201505241946,)
+                                                                               </versionRange>
+                                                                               <goals>
+                                                                                       <goal>prepare-agent</goal>
+                                                                               </goals>
+                                                                       </pluginExecutionFilter>
+                                                                       <action>
+                                                                               <ignore></ignore>
+                                                                       </action>
+                                                               </pluginExecution>
+                                                       </pluginExecutions>
+                                               </lifecycleMappingMetadata>
+                                       </configuration>
+                               </plugin>
+                       </plugins>
+               </pluginManagement>
+               <plugins>
+                       <plugin>
+                               <groupId>org.apache.maven.plugins</groupId>
+                               <artifactId>maven-compiler-plugin</artifactId>
+                               <version>3.3</version>
+                               <configuration>
+                                       <source>1.8</source>
+                                       <target>1.8</target>
+                                       <fork>true</fork>
+                               </configuration>
+                       </plugin>
+                       <plugin>
+                               <groupId>com.zenjava</groupId>
+                               <artifactId>javafx-maven-plugin</artifactId>
+                               <version>8.1.2</version>
+                               <configuration>
+                                       <mainClass>ch.some_package.SomeMain</mainClass>
+                               </configuration>
+                               <!-- See: http://stackoverflow.com/questions/19407959/javafx-maven-plugin-and-api-incompatibility -->
+                               <dependencies>
+                                       <dependency>
+                                               <groupId>org.twdata.maven</groupId>
+                                               <artifactId>mojo-executor</artifactId>
+                                               <version>2.2.0</version>
+                                       </dependency>
+                               </dependencies>
+                       </plugin>
+                       <plugin>
+                               <groupId>org.jacoco</groupId>
+                               <artifactId>jacoco-maven-plugin</artifactId>
+                               <executions>
+                                       <execution>
+                                               <id>prepare</id>
+                                               <phase>initialize</phase>
+                                               <goals>
+                                                       <goal>prepare-agent</goal>
+                                               </goals>
+                                       </execution>
+                                       <execution>
+                                               <id>report</id>
+                                               <phase>package</phase>
+                                               <goals>
+                                                       <goal>report</goal>
+                                               </goals>
+                                       </execution>
+                               </executions>
+                       </plugin>
+                       <plugin>
+                               <groupId>org.apache.maven.plugins</groupId>
+                               <artifactId>maven-site-plugin</artifactId>
+                               <version>3.4</version>
+                               <configuration>
+                                       <locales>en</locales>
+                                       <outputEncoding>UTF-8</outputEncoding>
+                                       <reportPlugins>
+                                               <plugin>
+                                                       <groupId>org.apache.maven.plugins</groupId>
+                                                       <artifactId>maven-project-info-reports-plugin</artifactId>
+                                                       <version>2.8.1</version>
+                                                       <configuration>
+                                                               <dependencyDetailsEnabled>false</dependencyDetailsEnabled>
+                                                               <dependencyLocationsEnabled>false</dependencyLocationsEnabled>
+                                                       </configuration>
+                                                       <reports>
+                                                               <report>dependencies</report>
+                                                               <report>project-team</report>
+                                                       </reports>
+                                               </plugin>
+                                               <!-- <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> 
+                                                       <version>2.9.1</version> </plugin> -->
+                                               <plugin>
+                                                       <groupId>org.apache.maven.plugins</groupId>
+                                                       <artifactId>maven-surefire-report-plugin</artifactId>
+                                                       <version>2.18.1</version>
+                                                       <reportSets>
+                                                               <reportSet>
+                                                                       <reports>
+                                                                               <report>report-only</report>
+                                                                               <report>failsafe-report-only</report>
+                                                                       </reports>
+                                                               </reportSet>
+                                                       </reportSets>
+                                               </plugin>
+                                               <plugin>
+                                                       <groupId>org.apache.maven.plugins</groupId>
+                                                       <artifactId>maven-jxr-plugin</artifactId>
+                                                       <version>2.5</version>
+                                               </plugin>
+                                               <plugin>
+                                                       <groupId>org.codehaus.mojo</groupId>
+                                                       <artifactId>jdepend-maven-plugin</artifactId>
+                                                       <version>2.0</version>
+                                               </plugin>
+                                               <!-- Note: Two Checkstyle reports are generated. Don't know yet why. -->
+                                               <plugin>
+                                                       <groupId>org.apache.maven.plugins</groupId>
+                                                       <artifactId>maven-checkstyle-plugin</artifactId>
+                                                       <version>2.16</version>
+                                                       <configuration>
+                                                               <configLocation>src/checkstyle/checkstyle-configuration.xml</configLocation>
+                                                               <headerLocation>src/checkstyle/checkstyle-header.txt</headerLocation>
+                                                       </configuration>
+                                                       <reportSets>
+                                                               <reportSet>
+                                                                       <reports>
+                                                                               <report>checkstyle</report>
+                                                                       </reports>
+                                                               </reportSet>
+                                                       </reportSets>
+                                               </plugin>
+                                       </reportPlugins>
+                               </configuration>
+                       </plugin>
+               </plugins>
+       </build>
+
+</project>
diff --git a/src/checkstyle/checkstyle-configuration.xml b/src/checkstyle/checkstyle-configuration.xml
new file mode 100644 (file)
index 0000000..87cd7d2
--- /dev/null
@@ -0,0 +1,55 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE module PUBLIC
+    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
+    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+
+<module name="Checker">
+
+    <!-- Checks that each Java package has a Javadoc file used for commenting. -->
+    <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
+    <!--module name="JavadocPackage">
+      <property name="allowLegacy" value="true"/>
+    </module-->
+
+    <module name="FileLength"/>
+
+    <!-- Checks for Headers. -->
+    <!-- See http://checkstyle.sf.net/config_header.html -->
+    <module name="RegexpHeader">
+        <property name="headerFile" value="${checkstyle.header.file}"/>
+    </module>
+
+    <!-- Line with trailing spaces. -->
+    <!-- See http://checkstyle.sourceforge.net/config_regexp.html#RegexpSingleline -->
+    <module name="RegexpSingleline">
+        <property name="format" value="\s+$"/>
+        <property name="message" value="Line has trailing spaces."/>
+    </module>
+
+    <!-- Checks whether files end with a new line. -->
+    <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
+    <module name="NewlineAtEndOfFile">
+        <property name="lineSeparator" value="lf"/>
+    </module>
+
+    <module name="TreeWalker">
+        <!-- Checks for long lines. -->
+        <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
+        <module name="LineLength">
+            <property name="max" value="360"/>
+        </module>
+        <!-- Checks for Star imports. -->
+        <!-- See http://checkstyle.sourceforge.net/config_imports.html -->
+        <module name="AvoidStarImport">
+            <!-- <property name="excludes" value="java.io,java.net,java.lang.Math"/> -->
+            <property name="allowClassImports" value="false"/>
+            <property name="allowStaticMemberImports" value="false"/>
+        </module>
+        <!-- Checks for non-visibility of members. -->
+        <!-- See http://checkstyle.sourceforge.net/config_design.html -->
+        <module name="VisibilityModifier">
+            <property name="protectedAllowed" value="true"/>
+        </module>
+    </module>
+</module>
diff --git a/src/checkstyle/checkstyle-header.txt b/src/checkstyle/checkstyle-header.txt
new file mode 100644 (file)
index 0000000..415a27f
--- /dev/null
@@ -0,0 +1,11 @@
+^/\*$
+^ \* Copyright \(c\) 201[56] Berner Fachhochschule, Switzerland\.$
+^ \* Bern University of Applied Sciences, Engineering and Information Technology,$
+^ \* Biel, Switzerland.$
+^ \*$
+^ \* Project Smart Reservation System.$
+^ \*$
+^ \* Distributable under GPL license\.$
+^ \* See terms of license at gnu\.org\.$
+^ \*/$
+^package 
\ No newline at end of file
diff --git a/src/site/apt/format.apt b/src/site/apt/format.apt
new file mode 100644 (file)
index 0000000..e3e31cc
--- /dev/null
@@ -0,0 +1,602 @@
+ -----
+ The APT format
+ -----
+ The Maven Team
+ -----
+ -----
+
+The APT format
+~~~~~~~~~~~~~~
+
+  In the following section, boxes containing text in typewriter-like font are
+  examples of APT source.
+
+* Document structure
+~~~~~~~~~~~~~~~~~~~~
+
+  A short APT document is contained in a single text file. A longer document
+  may be contained in a ordered list of text files. For instance, first text
+  file contains section 1, second text file contains section 2, and so on.
+
+      [Note:] Splitting the APT document in several text files on a section
+              boundary is not mandatory. The split may occur anywhere.
+              However doing so is recommended because a text file containing a
+              section is by itself a valid APT document.
+
+  A file contains a sequence of paragraphs and ``displays'' (non paragraphs
+  such as tables) separated by open lines.
+
+  A paragraph is simply a sequence of consecutive text lines.
+
++------------------------------------------------------------------------+
+  First line of first paragraph.
+  Second line of first paragraph.
+  Third line of first paragraph.
+
+  Line 1 of paragraph 2 (separated from first paragraph by an open line).
+  Line 2 of paragraph 2.
++------------------------------------------------------------------------+
+
+  The indentation of the first line of a paragraph is the main method used by
+  an APT processor to recognize the type of the paragraph. For example, a
+  section title must not be indented at all.
+
+  A ``plain'' paragraph must be indented by a certain amount of space. For
+  example, a plain paragraph which is not contained in a list may be indented
+  by two spaces.
+
++-------------------------------------------------+
+My section title (not indented).
+
+  My paragraph first line (indented by 2 spaces).
++-------------------------------------------------+
+
+  Indentation is not rigid. Any amount of space will do. You don't even need
+  to use a consistent indentation all over your document. What really matters
+  for an APT processor is whether the paragraph is not indented at all or,
+  when inside a list, whether a paragraph is more or less indented than the
+  first item of the list (more about this later).
+
++-------------------------------------------------------+
+    First paragraph has its first line indented by four
+spaces. Then the author did even bother to indent the
+other lines of the paragraph.
+
+  Second paragraph contains several lines which are all
+  indented by two spaces. This style is much nicer than
+  the one used for the previous paragraph.
++-------------------------------------------------------+
+
+  Note that tabs are expanded with a tab width set to 8.
+
+* Document elements
+~~~~~~~~~~~~~~~~~~~
+
+** Block level elements
+~~~~~~~~~~~~~~~~~~~~~~~
+
+*** Title
+~~~~~~~~~~
+
+  A title is optional. If used, it must appear as the first block of the
+  document.
+
++----------------------------------------------------------------------------+
+                                   ------
+                                   Title
+                                   ------
+                                   Author
+                                   ------
+                                    Date
++----------------------------------------------------------------------------+
+
+  A title block is indented (centering it is nicer). It begins with a line
+  containing at least 3 dashes (<<<--->>>).
+
+  After the first <<<--->>> line, one or several consecutive lines of text
+  (implicit line break after each line) specify the title of the document.
+
+  This text may immediately be followed by another <<<--->>> line and one or
+  several consecutive lines of text which specifies the author of the
+  document.
+
+  The author sub-block may optionally be followed by a date sub-block using the
+  same syntax.
+
+  The following example is used for a document with an title and a date but
+  with no declared author.
+
++----------------------------------------------------------------------------+
+                                   ------
+                                   Title
+                                   ------
+                                   ------
+                                    Date
+                                   ------
++----------------------------------------------------------------------------+
+
+  The last line is ignored. It is just there to make the block nicer.
+
+*** Paragraph
+~~~~~~~~~~~~~
+
+  Paragraphs other than the title block may appear before the first section.
+
++----------------------+
+  Paragraph 1, line 1.
+  Paragraph 1, line 2.
+
+  Paragraph 2, line 1.
+  Paragraph 2, line 2.
++----------------------+
+
+  Paragraphs are indented. They have already been described in the
+  {{{#Document_structure}Document structure}} section.
+
+*** Section
+~~~~~~~~~~~
+
+  Sections are created by inserting section titles into the document. Simple
+  documents need not contain sections.
+
++-----------------------------------+
+Section title
+
+* Sub-section title
+
+** Sub-sub-section title
+
+*** Sub-sub-sub-section title
+
+**** Sub-sub-sub-sub-section title
++-----------------------------------+
+
+  Section titles are not indented. A sub-section title begins with one
+  asterisk (<<<*>>>), a sub-sub-section title begins with two asterisks
+  (<<<**>>>), and so forth up to four sub-section levels.
+
+*** List
+~~~~~~~~
+
++---------------------------------------+
+      * List item 1.
+
+      * List item 2.
+
+       Paragraph contained in list item 2.
+
+           * Sub-list item 1.
+
+           * Sub-list item 2.
+
+      * List item 3.
++---------------------------------------+
+
+  List items are indented and begin with a asterisk (<<<*>>>).
+
+  Plain paragraphs more indented than the first list item are nested in that
+  list. Displays such as tables (not indented) are always nested in the
+  current list.
+
+  To nest a list inside a list, indent its first item more than its parent
+  list. To end a list, add a paragraph or list item less indented than the
+  current list.
+
+  Section titles always end a list. Displays cannot end a list but the
+  <<<[]>>> pseudo-element may be used to force the end of a list.
+
++------------------------------------+
+      * List item 3.
+        Force end of list:
+
+      []
+
+--------------------------------------------
+Verbatim text not contained in list item 3
+--------------------------------------------
++------------------------------------+
+
+  In the previous example, without the <<<[]>>>, the verbatim text (not
+  indented as all displays) would have been contained in list item 3.
+
+  A single <<<[]>>> may be used to end several nested lists at the same
+  time. The indentation of <<<[]>>> may be used to specify exactly which
+  lists should be ended. Example:
+
++------------------------------------+
+      * List item 1.
+
+      * List item 2.
+
+           * Sub-list item 1.
+
+           * Sub-list item 2.
+
+           []
+
+-------------------------------------------------------------------
+Verbatim text contained in list item 2, but not in sub-list item 2
+-------------------------------------------------------------------
++------------------------------------+
+
+  There are three kind of lists, the bullet lists we have already described,
+  the numbered lists and the definition lists.
+
++-----------------------------------------+
+      [[1]] Numbered item 1.
+
+                [[A]] Numbered item A.
+
+                [[B]] Numbered item B.
+
+      [[2]] Numbered item 2.
++-----------------------------------------+
+
+  A numbered list item begins with a label beetween 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.
+
+      [<<<[[a\]\]>>>] Lower-alpha numbering: a, b, c, d, etc.
+
+      [<<<[[A\]\]>>>] Upper-alpha numbering: A, B, C, D, etc.
+
+      [<<<[[i\]\]>>>] Lower-roman numbering: i, ii, iii, iv, etc.
+
+      [<<<[[I\]\]>>>] Upper-roman numbering: I, II, III, IV, etc.
+
+  The labels of the items other than the first one are ignored. It is
+  recommended to take the time to type the correct label for each item in
+  order to keep the APT source document readable.
+
++-------------------------------------------+
+      [Defined term 1] of definition list 2.
+
+      [Defined term 2] of definition list 2.
++-------------------------------------------+
+
+  A definition list item begins with a defined term: text between square
+  brackets.
+
+*** Verbatim text
+~~~~~~~~~~~~~~~~~
+
++----------------------------------------+
+----------------------------------------
+Verbatim
+        text,
+               preformatted,
+                               escaped.
+----------------------------------------
++----------------------------------------+
+
+  A verbatim block is not indented. It begins with a non indented line
+  containing at least 3 dashes (<<<--->>>). It ends with a similar line.
+
+  <<<+-->>> instead of <<<--->>> draws a box around verbatim text.
+
+  Like in HTML, verbatim text is preformatted. Unlike HTML, verbatim text is
+  escaped: inside a verbatim display, markup is not interpreted by the APT
+  processor.
+
+*** Figure
+~~~~~~~~~~
+
++---------------------------+
+[Figure name] Figure 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.
+
+*** Table
+~~~~~~~~~
+
+  A table block is not indented. It begins with a non indented line containing
+  an asterisk and at least 2 dashes (<<<*-->>>). It ends with a
+  similar line.
+
+  The first line is not only used to recognize a table but also to specify
+  column justification. In the following example,
+
+      * the second asterisk (<<<*>>>) is used to specify that column 1 is
+        centered,
+
+      * the plus sign (<<<+>>>) specifies that column 2 is left aligned,
+
+      * the colon (<<<:>>>) specifies that column 3 is right aligned.
+
+      []
+
++---------------------------------------------+
+*----------*--------------+----------------:
+| Centered | Left-aligned | Right-aligned  |
+| cell 1,1 | cell 1,2     | cell 1,3       |
+*----------*--------------+----------------:
+| cell 2,1 | cell 2,2     | cell 2,3       |
+*----------*--------------+----------------:
+Table caption
++---------------------------------------------+
+
+  Rows are separated by a non indented line beginning with <<<*-->>>.
+
+  An optional table caption (non indented text) may immediately follow the
+  table.
+
+  Rows may contain single line or multiple line cells. Each line of cell text
+  is separated from the adjacent cell by the pipe character (<<<|>>>).
+  (<<<|>>> may be used in the cell text if quoted: <<<\\|>>>.)
+
+  The last <<<|>>> is only used to make the table nicer.  The first <<<|>>> is
+  not only used to make the table nicer, but also to specify that a grid is to
+  be drawn around table cells.
+
+  The following example shows a simple table with no grid and no caption.
+
++---------------+
+*-----*------*
+ cell | cell
+*-----*------*
+ cell | cell
+*-----*------*
++---------------+
+
+*** Horizontal rule
+~~~~~~~~~~~~~~~~~~~
+
++---------------------+
+=====================
++---------------------+
+
+  A non indented line containing at least 3 equal signs (<<<===>>>).
+
+*** Page break
+~~~~~~~~~~~~~~
+
++---+
+^L
++---+
+
+  A non indented line containing a single form feed character (Control-L).
+
+** Text level elements
+~~~~~~~~~~~~~~~~~~~~~~
+
+*** Font
+~~~~~~~~
+
++-----------------------------------------------------+
+  <Italic> font. <<Bold>> font. <<<Monospaced>>> font.
++-----------------------------------------------------+
+
+  Text between \< and > must be rendered in italic. Text between \<\< and >>
+  must be rendered in bold. Text between \<\<\< and >>> must be rendered using
+  a mono-spaced, typewriter-like font.
+
+  Font elements may appear anywhere except inside other font elements.
+
+  It is not recommended to use font elements inside titles, section titles,
+  links and defined terms because a APT processor automatically applies
+  appropriate font styles to these elements.
+
+*** Anchor and link
+~~~~~~~~~~~~~~~~~~~
+
++-----------------------------------------------------------------+
+  {Anchor}. Link to {{anchor}}. Link to {{http://www.pixware.fr}}.
+  Link to {{{anchor}showing alternate text}}.
+  Link to {{{http://www.pixware.fr}Pixware home page}}.
++-----------------------------------------------------------------+
+
+  Text between curly braces (<<<\{}>>>) specifies an anchor. Text between
+  double curly braces (<<<\{\{}}>>>) specifies a link.
+
+  It is an error to create a link element that does not refer to an anchor of
+  the same name. The name of an anchor/link is its text with all non
+  alphanumeric characters stripped.
+
+  This rule does not apply to links to <external> anchors. Text beginning
+  with <<<http:/>>>, <<<https:/>>>, <<<ftp:/>>>, <<<file:/>>>, <<<mailto:>>>,
+  <<<../>>>, <<<./>>> (<<<..\\>>> and <<<.\\>>> on Windows) is recognized as
+  an external anchor name.
+
+  When the construct <<\{\{\{>><name><<}>><text><<}}>> is used, the link text
+  <text> may differ from the link name <name>.
+
+  Anchor/link elements may appear anywhere except inside other anchor/link
+  elements.
+
+  Section titles are implicitly defined anchors.
+
+*** Line break
+~~~~~~~~~~~~~~
+
++-------------+
+  Force line\
+  break.
++-------------+
+
+  A backslash character (<<<\\>>>) followed by a newline character.
+
+  Line breaks must not be used inside titles and tables (which are line
+  oriented blocks with implicit line breaks).
+
+*** Non breaking space
+~~~~~~~~~~~~~~~~~~~~~~
+
++----------------------+
+  Non\ breaking\ space.
++----------------------+
+
+  A backslash character (<<<\\>>>) followed by a space character.
+
+*** Special character
+~~~~~~~~~~~~~~~~~~~~~
+
++---------------------------------------------------------------------------+
+  Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.
++---------------------------------------------------------------------------+
+
+  In certain contexts, these characters have a special meaning and therefore
+  must be escaped if needed as is. They are escaped by adding a backslash in
+  front of them. The backslash may itself be escaped by adding another
+  backslash in front of it.
+
+  Note that an asterisk, for example, needs to be escaped only if its begins a
+  paragraph. (<<<*>>> has no special meaning in the middle of a paragraph.)
+
++--------------------------------------+
+  Copyright symbol: \251, \xA9, \u00a9.
++--------------------------------------+
+
+  Latin-1 characters (whatever is the encoding of the APT document) may be
+  specified by their codes using a backslash followed by one to three octal
+  digits or by using the <<<\x>>><NN> notation, where <NN> are two hexadecimal
+  digits.
+
+  Unicode characters may be specified by their codes using the <<<\u>>><NNNN>
+  notation, where <NNNN> are four hexadecimal digits.
+
+*** Comment
+~~~~~~~~~~~
+
++---------------+
+~~Commented out.
++---------------+
+
+  Text found after two tildes (<<<\~~>>>) is ignored up to the end of line.
+
+  A line of <<<~>>> is often used to ``underline'' section titles in order to
+  make them stand out of other paragraphs.
+
+\f
+* The APT format at a glance
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+------------------------------------------------------------------------------
+                                   ------
+                                   Title
+                                   ------
+                                   Author
+                                   ------
+                                    Date
+
+  Paragraph 1, line 1.
+  Paragraph 1, line 2.
+
+  Paragraph 2, line 1.
+  Paragraph 2, line 2.
+
+Section title
+
+* Sub-section title
+
+** Sub-sub-section title
+
+*** Sub-sub-sub-section title
+
+**** Sub-sub-sub-sub-section title
+
+      * List item 1.
+
+      * List item 2.
+
+       Paragraph contained in list item 2.
+
+           * Sub-list item 1.
+
+           * Sub-list item 2.
+
+      * List item 3.
+        Force end of list:
+
+      []
+
++------------------------------------------+
+Verbatim text not contained in list item 3
++------------------------------------------+
+
+      [[1]] Numbered item 1.
+
+                [[A]] Numbered item A.
+
+                [[B]] Numbered item B.
+
+      [[2]] Numbered item 2.
+
+  List numbering schemes: [[1]], [[a]], [[A]], [[i]], [[I]].
+
+      [Defined term 1] of definition list.
+
+      [Defined term 2] of definition list.
+
++-------------------------------+
+Verbatim text
+                       in a box
++-------------------------------+
+
+  --- instead of +-- suppresses the box around verbatim text.
+
+[Figure name] Figure caption
+
+*----------*--------------+----------------:
+| Centered | Left-aligned | Right-aligned  |
+| cell 1,1 | cell 1,2     | cell 1,3       |
+*----------*--------------+----------------:
+| cell 2,1 | cell 2,2     | cell 2,3       |
+*----------*--------------+----------------:
+Table caption
+
+  No grid, no caption:
+
+*-----*------*
+ cell | cell
+*-----*------*
+ cell | cell
+*-----*------*
+
+  Horizontal line:
+
+=======================================================================
+
+^L
+  New page.
+
+  <Italic> font. <<Bold>> font. <<<Monospaced>>> font.
+
+  {Anchor}. Link to {{anchor}}. Link to {{http://www.pixware.fr}}.
+  Link to {{{anchor}showing alternate text}}.
+  Link to {{{http://www.pixware.fr}Pixware home page}}.
+
+  Force line\
+  break.
+
+  Non\ breaking\ space.
+
+  Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.
+
+  Copyright symbol: \251, \xA9, \u00a9.
+
+~~Commented out.
+
+------------------------------------------------------------------------------
+
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
new file mode 100644 (file)
index 0000000..517805f
--- /dev/null
@@ -0,0 +1,10 @@
+The Maven Site of the Smart Reservation System
+
+       This is the Smart Reservation System (SRS) project of .... To generate
+       this site, go to the root directory of the project, and then type:
+
++-----+
+
+mvn clean package site
+
++-----+
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
new file mode 100644 (file)
index 0000000..b8c4d47
--- /dev/null
@@ -0,0 +1,27 @@
+<?xml version="1.0"?>
+<faqs xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/FML/1.0"
+  xsi:schemaLocation="http://maven.apache.org/FML/1.0 http://maven.apache.org/xsd/fml-1.0.xsd"
+  id="General FAQ">
+  <part id="General">
+    <faq id="where">
+      <question>Where did Maven come from?</question>
+      <answer>
+        <p>
+          Maven was created by a group of software developers who were tired
+          of wasting their time fiddling around with builds and wanted to get
+          down to brass tacks and actually develop software!
+        </p>
+      </answer>
+    </faq>
+    <faq id="why">
+      <question>Why is Maven so wildly popular?</question>
+      <answer>
+        <p>
+          Maven saves you so much time in your software development efforts that
+          you will have time to learn a second language, relax ten hours a
+          day, and train for that marathon you've always wanted to run!
+        </p>
+      </answer>
+    </faq>
+  </part>
+</faqs>
diff --git a/src/site/resources/doc/vision.pdf b/src/site/resources/doc/vision.pdf
new file mode 100644 (file)
index 0000000..4c8113f
Binary files /dev/null and b/src/site/resources/doc/vision.pdf differ
diff --git a/src/site/resources/images/bfh-ti-de.gif b/src/site/resources/images/bfh-ti-de.gif
new file mode 100644 (file)
index 0000000..820764e
Binary files /dev/null and b/src/site/resources/images/bfh-ti-de.gif differ
diff --git a/src/site/site.xml b/src/site/site.xml
new file mode 100644 (file)
index 0000000..d47ed42
--- /dev/null
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<project name="Diary Project" xmlns="http://maven.apache.org/DECORATION/1.0.0"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
+
+    <bannerLeft>
+        <name>Smart Reservation System</name>
+        <src>images/bfh-ti-de.gif</src>
+        <href>http://www.ti.bfh.ch</href>
+    </bannerLeft>
+
+    <version position="right" />
+
+    <body>
+        <breadcrumbs>
+            <item name="BFH-TI" href="http://www.ti.bfh.ch" />
+        </breadcrumbs>
+
+               <menu name="Process Documentation">
+                       <item name="About" href="index.html" />
+                       <item name="The Vision" href="doc/vision.pdf" />
+               </menu>
+               <menu name="Resources">
+                       <item name="The APT Format" href="format.html" />
+                       <item name="The FAQ Format" href="faq.html" />
+               </menu>
+               <menu ref="reports" />
+               <menu name="Additional Reports">
+                       <item name="Test Coverage" href="jacoco/index.html" />
+               </menu>
+
+       </body>
+
+</project>