SAK-17054 add info for site genration

git-svn-id: https://source.sakaiproject.org/svn/search/trunk@66976 66ffb92e-73f9-0310-93c1-f5514f145a0a
susowrc · Sep 30, 2009 · f005d4a · f005d4a
1 parent 08c8823
commit f005d4a
Show file tree

Hide file tree

Showing 19 changed files with 1,740 additions and 0 deletions.
diff --git a/search/pom.xml b/search/pom.xml
@@ -21,6 +21,9 @@
 		</url>
 	</scm>
 	<packaging>pom</packaging>
+	<properties>
+		<url.localsite>scp://source.sakaiproject.org/var/www/html/release/search/${project.version}</url.localsite>
+	</properties>
 	<profiles>
 		<profile>
 			<id>framework</id>
@@ -131,4 +134,123 @@
 			</snapshots>
 		</repository>
 	</repositories>
+	<developers>
+		 <developer>
+            <id>[email protected]</id>
+            <name>David Horwitz</name>
+            <email>[email protected]</email>
+            <url>http://blogs.uct.ac.za/blog/daves-blog</url>
+            <organization>
+                Centre for Educational Technology, University of Cape
+                Town
+            </organization>
+            <organizationUrl>http://www.cet.uct.ac.za</organizationUrl>
+            <roles>
+                <role>developer</role>
+                <role>branch manager</role>
+            </roles>
+            <timezone>+2</timezone>
+            <properties>
+                <picUrl>
+                    http://www.sakaiproject.org/access/content/group/sakai-community/images/people/horwitzdavid_sakaigers_100x80.jpg
+                </picUrl>
+            </properties>
+            </developer>
+            <developer>
+            <id>[email protected]</id>
+            <name>Stephen Marquard</name>
+            <email>[email protected]</email>
+            <organization>
+                Centre for Educational Technology, University of Cape
+                Town
+            </organization>
+            <organizationUrl>http://www.cet.uct.ac.za</organizationUrl>
+            <roles>
+                <role>developer</role>
+            </roles>
+            <timezone>+2</timezone>
+            <properties>
+                <picUrl>
+                    http://www.sakaiproject.org/access/content/group/sakai-foundation/images/people/marquard_100x77.jpg
+                </picUrl>
+            </properties>
+        </developer>
+	</developers>
+	<contributors>
+	 <contributor>
+            <name>Ian Boston</name>
+            <email>[email protected]</email>
+            <url>http://blog.tfd.co.uk/</url>
+            <organization>
+                Centre for Applied Research in Educational Technologies,
+                University of Cambridge
+            </organization>
+            <organizationUrl>
+                http://www.caret.cam.ac.uk
+            </organizationUrl>
+            <roles>
+                <role>architect</role>
+            </roles>
+            <timezone>0</timezone>
+            <properties>
+                <picUrl>
+                    http://www.caret.cam.ac.uk/wp-content/uploads/2008/12/ian.jpg
+                </picUrl>
+            </properties>
+        </contributor>
+	</contributors>
+    <!-- Reporting (mvn site) -->
+    <reporting>
+        <plugins>
+            <!-- JavaDocs: mvn javadoc:javadoc -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <configuration>
+                    <aggregate>true</aggregate>
+                    <source>1.5</source>
+                    <links>
+                        <link>http://java.sun.com/j2se/1.5.0/docs/api</link>
+                        <link>http://java.sun.com/products/servlet/2.3/javadoc/</link>
+                    </links>
+                    <breakiterator>true</breakiterator>
+                    <verbose>false</verbose>
+                    <maxmemory>512m</maxmemory>
+                    <additionalJOption>
+                        -J-Xms168m -J-Xmx512m -J-XX:PermSize=128m -J-XX:NewSize=64m
+          </additionalJOption>
+                </configuration>
+            </plugin>
+            <!-- FindBugs: mvn findbugs:findbugs -->
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>findbugs-maven-plugin</artifactId>
+                <version>1.2</version>
+                <configuration>
+                    <findbugsXmlOutput>true</findbugsXmlOutput>
+                    <findbugsXmlWithMessages>true</findbugsXmlWithMessages>
+                    <xmlOutput>true</xmlOutput>
+                </configuration>
+            </plugin>
+            <!-- CheckStyle: mvn checkstyle:checkstyle -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <configuration>
+                    <outputFileFormat>xml</outputFileFormat>
+                </configuration>
+            </plugin>
+            <!-- Cobertura: mvn cobertura:cobertura -->
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>cobertura-maven-plugin</artifactId>
+                <configuration>
+                    <formats>
+                        <format>html</format>
+                        <format>xml</format>
+                    </formats>
+                </configuration>
+            </plugin>
+        </plugins>
+    </reporting>
 </project>
diff --git a/search/src/site/apt/app-servers.apt b/search/src/site/apt/app-servers.apt
@@ -0,0 +1,104 @@
+                                    ------
+                                    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/search/src/site/apt/architecture.apt b/search/src/site/apt/architecture.apt
@@ -0,0 +1,104 @@
+                                    ------
+                                    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.