Skip to content

Commit c02edf6

Browse files
author
Emmanuel Hugonnet
committed
First commit for documentation
0 parents  commit c02edf6

File tree

7 files changed

+441
-0
lines changed

7 files changed

+441
-0
lines changed

‎.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*.iws
2+
*.ipr
3+
*.iml
4+
*.merge*
5+
catalog.xml
6+
target
7+
.settings
8+
.classpath
9+
.project
10+
nbactions.xml
11+
nb-configuration.xml
12+
nbactions.xml

‎pom.xml

Lines changed: 278 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,278 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
4+
Copyright (C) 2000 - 2012 Silverpeas
5+
6+
This program is free software: you can redistribute it and/or modify
7+
it under the terms of the GNU Affero General Public License as
8+
published by the Free Software Foundation, either version 3 of the
9+
License, or (at your option) any later version.
10+
11+
As a special exception to the terms and conditions of version 3.0 of
12+
the GPL, you may redistribute this Program in connection with Free/Libre
13+
Open Source Software ("FLOSS") applications as described in Silverpeas's
14+
FLOSS exception. You should have received a copy of the text describing
15+
the FLOSS exception, and it is also available here:
16+
"http://www.silverpeas.org/legal/licensing"
17+
18+
This program is distributed in the hope that it will be useful,
19+
but WITHOUT ANY WARRANTY; without even the implied warranty of
20+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21+
GNU Affero General Public License for more details.
22+
23+
You should have received a copy of the GNU Affero General Public License
24+
along with this program. If not, see <http://www.gnu.org/licenses/>.
25+
26+
-->
27+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
28+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
29+
<modelVersion>4.0.0</modelVersion>
30+
<parent>
31+
<groupId>com.silverpeas</groupId>
32+
<version>24-SNAPSHOT</version>
33+
<artifactId>parent</artifactId>
34+
</parent>
35+
36+
<groupId>org.silverpeas</groupId>
37+
<artifactId>documentation</artifactId>
38+
<version>5.11-SNAPSHOT</version>
39+
<packaging>pom</packaging>
40+
<name>Silverpeas documentation</name>
41+
<description>The Silverpeas documentation</description>
42+
43+
44+
45+
46+
<properties>
47+
<wikbook.version>0.9.40</wikbook.version>
48+
<silverpeas.version>${project.version}</silverpeas.version>
49+
<wikbook.source>${pom.basedir}/src/main/wikbook</wikbook.source>
50+
<wikbook.target>${project.build.directory}/wikbook</wikbook.target>
51+
</properties>
52+
<dependencies>
53+
<dependency>
54+
<groupId>org.wikbook</groupId>
55+
<artifactId>wikbook.docbkxstyle</artifactId>
56+
<version>${wikbook.version}</version>
57+
</dependency>
58+
</dependencies>
59+
60+
<build>
61+
<plugins>
62+
<!-- The wikbook maven plugin generates the docbook document from the wiki source -->
63+
<plugin>
64+
<groupId>org.wikbook</groupId>
65+
<artifactId>wikbook.maven</artifactId>
66+
<version>${wikbook.version}</version>
67+
<executions>
68+
<execution>
69+
<phase>prepare-package</phase>
70+
<goals>
71+
<goal>transform</goal>
72+
</goals>
73+
</execution>
74+
</executions>
75+
<configuration>
76+
<sourceDirectory>${wikbook.source}/en/en-US</sourceDirectory>
77+
<extraSourceDirectory>${wikbook.target}/man</extraSourceDirectory>
78+
<sourceFileName>book.wiki</sourceFileName>
79+
<destinationDirectory>${wikbook.target}/src</destinationDirectory>
80+
<destinationFileName>index.xml</destinationFileName>
81+
<emitDoctype>false</emitDoctype>
82+
<beforeBookBodyXML><![CDATA[<xi:include href="bookinfo.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />]]></beforeBookBodyXML>
83+
</configuration>
84+
</plugin>
85+
<!-- Unpacks the docbook style resources for the docbkx plugin -->
86+
<plugin>
87+
<groupId>org.apache.maven.plugins</groupId>
88+
<artifactId>maven-dependency-plugin</artifactId>
89+
<executions>
90+
<execution>
91+
<id>a</id>
92+
<phase>prepare-package</phase>
93+
<goals>
94+
<goal>unpack-dependencies</goal>
95+
</goals>
96+
<configuration>
97+
<includeGroupIds>org.wikbook</includeGroupIds>
98+
<includeArtifactIds>wikbook.docbkxstyle</includeArtifactIds>
99+
<excludes>META-INF/**</excludes>
100+
<outputDirectory>${wikbook.target}/src/resources</outputDirectory>
101+
</configuration>
102+
</execution>
103+
</executions>
104+
</plugin>
105+
106+
<!-- Dockbx plugin that generates content -->
107+
<plugin>
108+
<groupId>com.agilejava.docbkx</groupId>
109+
<artifactId>docbkx-maven-plugin</artifactId>
110+
<version>2.0.14</version>
111+
<configuration>
112+
<!-- Source -->
113+
<sourceDirectory>${wikbook.target}/src</sourceDirectory>
114+
<includes>index.xml</includes>
115+
<!-- Highlight source code -->
116+
<highlightSource>1</highlightSource>
117+
<!-- We need to support xinclude -->
118+
<xincludeSupported>true</xincludeSupported>
119+
<!--
120+
| See http://www.sagehill.net/docbookxsl/AnnotateListing.html
121+
| Callouts on imported text
122+
-->
123+
<useExtensions>1</useExtensions>
124+
<calloutsExtension>1</calloutsExtension>
125+
<!-- Copy any docbook XML -->
126+
<preProcess>
127+
<copy todir="${wikbook.target}/src">
128+
<fileset dir="${wikbook.source}/en/en-US">
129+
<include name="**/*.xml" />
130+
</fileset>
131+
</copy>
132+
</preProcess>
133+
</configuration>
134+
<executions>
135+
<execution>
136+
<id>generate-html</id>
137+
<goals>
138+
<goal>generate-html</goal>
139+
</goals>
140+
<phase>package</phase>
141+
<configuration>
142+
<!-- Output -->
143+
<targetDirectory>${wikbook.target}/output/html</targetDirectory>
144+
<!-- Stylesheet -->
145+
<htmlCustomization>${wikbook.target}/src/resources/xsl/bootstrap/html.xsl</htmlCustomization>
146+
<!-- Copy the image -->
147+
<postProcess>
148+
<copy todir="${wikbook.target}/output/html/images">
149+
<fileset dir="${wikbook.source}/images">
150+
<include name="**" />
151+
</fileset>
152+
</copy>
153+
<copy todir="${wikbook.target}/output/html">
154+
<fileset dir="${wikbook.target}/src/resources">
155+
<include name="**/*.css" />
156+
<include name="**/*.js" />
157+
<include name="**/*.png" />
158+
<include name="**/*.gif" />
159+
<include name="**/*.jpg" />
160+
</fileset>
161+
</copy>
162+
</postProcess>
163+
</configuration>
164+
</execution>
165+
<execution>
166+
<id>generate-xhtml</id>
167+
<goals>
168+
<goal>generate-xhtml</goal>
169+
</goals>
170+
<phase>package</phase>
171+
<configuration>
172+
173+
<!-- Output -->
174+
<targetDirectory>${wikbook.target}/output/xhtml</targetDirectory>
175+
<targetFileExtension>html</targetFileExtension>
176+
177+
<!-- Stylesheet -->
178+
<xhtmlCustomization>${wikbook.target}/src/resources/xsl/simple/pdf.xsl</xhtmlCustomization>
179+
180+
<!-- Copy the image -->
181+
<postProcess>
182+
<copy todir="${wikbook.target}/output/xhtml/images">
183+
<fileset dir="${pom.basedir}/src/main/wikbook/images">
184+
<include name="**" />
185+
</fileset>
186+
</copy>
187+
<copy todir="${wikbook.target}/output/xhtml">
188+
<fileset dir="${wikbook.target}/src/resources">
189+
<include name="**/*.css" />
190+
<include name="**/*.png" />
191+
<include name="**/*.gif" />
192+
<include name="**/*.jpg" />
193+
</fileset>
194+
</copy>
195+
</postProcess>
196+
</configuration>
197+
</execution>
198+
</executions>
199+
<dependencies>
200+
<dependency>
201+
<groupId>org.docbook</groupId>
202+
<artifactId>docbook-xml</artifactId>
203+
<version>4.5</version>
204+
<scope>runtime</scope>
205+
</dependency>
206+
</dependencies>
207+
</plugin>
208+
209+
<plugin>
210+
<groupId>org.wikbook</groupId>
211+
<artifactId>wikbook.html2pdf</artifactId>
212+
<version>${wikbook.version}</version>
213+
<executions>
214+
<execution>
215+
<phase>package</phase>
216+
<goals>
217+
<goal>transform</goal>
218+
</goals>
219+
</execution>
220+
</executions>
221+
<configuration>
222+
<sourceDirectory>${wikbook.target}/output/xhtml</sourceDirectory>
223+
<sourceFileName>index.html</sourceFileName>
224+
<destinationDirectory>${wikbook.target}/output/pdf</destinationDirectory>
225+
<destinationFileName>index.pdf</destinationFileName>
226+
</configuration>
227+
</plugin>
228+
229+
<!-- Attach the HTML zip -->
230+
<plugin>
231+
<artifactId>maven-assembly-plugin</artifactId>
232+
<executions>
233+
<execution>
234+
<phase>package</phase>
235+
<goals>
236+
<goal>single</goal>
237+
</goals>
238+
<configuration>
239+
<descriptors>
240+
<descriptor>src/main/assembly/html.xml</descriptor>
241+
<descriptor>src/main/assembly/docbook.xml</descriptor>
242+
</descriptors>
243+
</configuration>
244+
</execution>
245+
</executions>
246+
</plugin>
247+
248+
<!-- Attach the PDF -->
249+
<plugin>
250+
<groupId>org.codehaus.mojo</groupId>
251+
<artifactId>build-helper-maven-plugin</artifactId>
252+
<version>1.7</version>
253+
<executions>
254+
<execution>
255+
<id>attach-artifacts</id>
256+
<phase>package</phase>
257+
<goals>
258+
<goal>attach-artifact</goal>
259+
</goals>
260+
<configuration>
261+
<artifacts>
262+
<artifact>
263+
<file>target/wikbook/output/pdf/index.pdf</file>
264+
<type>pdf</type>
265+
</artifact>
266+
</artifacts>
267+
</configuration>
268+
</execution>
269+
</executions>
270+
</plugin>
271+
272+
273+
274+
</plugins>
275+
276+
</build>
277+
278+
</project>

‎src/main/assembly/docbook.xml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
Copyright (C) 2000 - 2012 Silverpeas
4+
5+
This program is free software: you can redistribute it and/or modify
6+
it under the terms of the GNU Affero General Public License as
7+
published by the Free Software Foundation, either version 3 of the
8+
License, or (at your option) any later version.
9+
10+
As a special exception to the terms and conditions of version 3.0 of
11+
the GPL, you may redistribute this Program in connection withWriter Free/Libre
12+
Open Source Software ("FLOSS") applications as described in Silverpeas's
13+
FLOSS exception. You should have recieved a copy of the text describing
14+
the FLOSS exception, and it is also available here:
15+
"http://www.silverpeas.org/legal/licensing"
16+
17+
This program is distributed in the hope that it will be useful,
18+
but WITHOUT ANY WARRANTY; without even the implied warranty of
19+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20+
GNU Affero General Public License for more details.
21+
22+
You should have received a copy of the GNU Affero General Public License
23+
along with this program. If not, see <http://www.gnu.org/licenses/>.
24+
-->
25+
26+
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.1"
27+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
28+
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.1 http://maven.apache.org/xsd/assembly-1.1.1.xsd">
29+
<id>docbook</id>
30+
<formats>
31+
<format>zip</format>
32+
</formats>
33+
<includeBaseDirectory>false</includeBaseDirectory>
34+
<fileSets>
35+
<fileSet>
36+
<directory>target/wikbook/src</directory>
37+
<outputDirectory>/</outputDirectory>
38+
</fileSet>
39+
</fileSets>
40+
</assembly>

‎src/main/assembly/html.xml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
Copyright (C) 2000 - 2012 Silverpeas
4+
5+
This program is free software: you can redistribute it and/or modify
6+
it under the terms of the GNU Affero General Public License as
7+
published by the Free Software Foundation, either version 3 of the
8+
License, or (at your option) any later version.
9+
10+
As a special exception to the terms and conditions of version 3.0 of
11+
the GPL, you may redistribute this Program in connection withWriter Free/Libre
12+
Open Source Software ("FLOSS") applications as described in Silverpeas's
13+
FLOSS exception. You should have recieved a copy of the text describing
14+
the FLOSS exception, and it is also available here:
15+
"http://www.silverpeas.org/legal/licensing"
16+
17+
This program is distributed in the hope that it will be useful,
18+
but WITHOUT ANY WARRANTY; without even the implied warranty of
19+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20+
GNU Affero General Public License for more details.
21+
22+
You should have received a copy of the GNU Affero General Public License
23+
along with this program. If not, see <http://www.gnu.org/licenses/>.
24+
-->
25+
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.1"
26+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
27+
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.1 http://maven.apache.org/xsd/assembly-1.1.1.xsd">
28+
<id>html</id>
29+
<formats>
30+
<format>zip</format>
31+
</formats>
32+
<includeBaseDirectory>false</includeBaseDirectory>
33+
<fileSets>
34+
<fileSet>
35+
<directory>target/wikbook/output/html</directory>
36+
<outputDirectory>/</outputDirectory>
37+
</fileSet>
38+
</fileSets>
39+
</assembly>
40+

‎src/main/wikbook/en/en-US/book.wiki

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
= Collaborative workspaces =
2+
3+
Use Silverpeas to build an Intranet or Extranet and feed web 2.0 sites optimizing sharing and performance.
4+
Based on it's collaborative bus, Silverpeas is used to share documents (EDM Electronic Documentation Management), to optimize project managment, content management and knowledge and skills management.
5+
Silverpeas improves and encourages best practices and helps the creation of social networks, thanks to improved workflow and information management.
6+
7+
8+
= Ready-to-use aplications =
9+
10+
With more than **30 ready-to-use applications**, Silverpeas™ combines all the tools you need to get your collaborative spaces up and running in a few clicks. Applications such as Blog, wiki, forum, directories, project management, ECM, picture gallery, diaries, and many more let you develop your own personalized space. Other features: EDM (Electronic Documentation Management)Collaborative tools, agendas, booking system, chat, yellow pages, social network, survey, quiz, forums,Project management tools (gantt)Knowledge managementContent management tools such as blogs, image gallery, 3D browser, EDM, RSS flows,Workflow engine with XML forms, connections to Databases, and groupware (Domino, Groupwise, Zimbra, Outlook)...
11+
12+
A transverse social Network gives a user centric access to informations and activities.
13+
14+
= Hey, I want to contribute! =
15+
16+
Drop an email on the mailing list ( http://groups.google.com/group/silverpeas-users ), any kind of help is welcome.

0 commit comments

Comments
 (0)