Author: hboutemy
Date: Sat Nov 12 02:31:39 2011
New Revision: 1201168
URL: http://svn.apache.org/viewvc?rev=1201168&view=rev
Log:
improved index page for ITs to better focus on their objective and let users
know the configuration
Modified:
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/pom.xml
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/src/site/apt/index.apt.vm
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/src/site/site.xml
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/pom.xml
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/src/site/apt/index.apt.vm
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/src/site/site.xml
Modified: maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/pom.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/pom.xml?rev=1201168&r1=1201167&r2=1201168&view=diff
==============================================================================
--- maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/pom.xml (original)
+++ maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/pom.xml Sat Nov
12 02:31:39 2011
@@ -25,11 +25,11 @@
</parent>
<groupId>org.apache.maven.skins.its</groupId>
- <artifactId>@project.artifactId@</artifactId>
+ <artifactId>@project.artifactId@-sidebar</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
- <name>@project.artifactId@ IT</name>
+ <name>@project.name@ IT, sidebar layout</name>
<url>http://maven.apache.org/skins/@project.artifactId@/sidebar/</url>
<properties>
Modified:
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/src/site/apt/index.apt.vm?rev=1201168&r1=1201167&r2=1201168&view=diff
==============================================================================
---
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/src/site/apt/index.apt.vm
(original)
+++
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/src/site/apt/index.apt.vm
Sat Nov 12 02:31:39 2011
@@ -1,207 +1,16 @@
------
- ${skinName} test
+ ${project.name}
------
Hervé Boutemy
------
2011-10-15
------
-${skinName} test
+${project.name}
- This is a test for ${skinName}.
+ This is a test for ${skinName} with sidebar enabled and Google Search.
${skinDescription}
-* Usage
+* Actual configuration
- To use this skin in your project, use the skin element of
- {{{/doxia/doxia-sitetools/doxia-decoration-model/decoration.html}the
<<<site.xml>>> site descriptor}}:
-
-+-----+
-<project name="xxx">
- ...
- <skin>
- <groupId>${skinGroupId}</groupId>
- <artifactId>${skinArtifactId}</artifactId>
- <version>${skinVersion}</version>
- </skin>
- ...
-</project>
-+-----+
-
- The skin supports different layouts, enabling/disabling the left sidebar menu
and the topbar menu.
- Users have just play with flags in the <<<custom/fluidoSkin>>> element in
<<<site.xml>>>:
-
-+-----+
-<project name="xxx">
- ...
- <custom>
- <fluidoSkin>
- <topBarEnabled>true</topBarEnabled>
- <sideBarEnabled>false</sideBarEnabled>
- </fluidoSkin>
- </custom>
- ...
-</project>
-+-----+
-
- When users decide to enable the topbar, they can plug a small icon/logo there
(typically 108*20 px) just configuring
- the <<<custom/fluidoSkin/topBarIcon>>> element in <<<site.xml>>>:
-
-+-----+
-<project name="xxx">
- ...
- <custom>
- <fluidoSkin>
- <topBarEnabled>true</topBarEnabled>
- <topBarIcon>
- <name>Maven Fluido Skin</name>
- <alt>Maven Fluido Skin</alt>
- <src>/images/topbar-logo.png</src>
- <href>/index.html</href>
- </topBarIcon>
- </fluidoSkin>
- </custom>
- ...
-</project>
-+-----+
-
- Users can optionally enable the <<Google Search>> for the generated site,
requirements are:
-
- * the <<<project/url>>> property in <<<pom.xml>>>:
-
-+-----+
-<project>
-...
- <url>http://maven.apache.org/skins/${project.artifactId}</url>
-...
-</project>
-+-----+
-
- * the <<<custom/fluidoSkin/searchEnabled>>> element in <<<site.xml>>>:
-
-+-----+
-<project name="xxx">
- ...
- <custom>
- <fluidoSkin>
- <searchEnabled>true</searchEnabled>
- </fluidoSkin>
- </custom>
- ...
-</project>
-+-----+
-
- By default, the search form:
-
- * is <not> enabled;
- * is rendered in the sidebar, if the topbar only is available it will be
rendered there.
-
-Sample content
-
- 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
-+-------------------------------+
-
----------------------------------
-Verbatim text
- without box
----------------------------------
-
-[figure] 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
-*-----*------*
-
-*---------*---------*
-|| header || header |
-*---------*---------*
-| cell | cell |
-*---------*---------*
-
- Horizontal line:
-
-=======================================================================
-
- <Italic> font. <<Bold>> font. <<<Monospaced>>> font.
-
- {Anchor}. Link to {{Anchor}}.
- Link to {{{Anchor}showing alternate text}}.
- Link to {{{http://www.pixware.fr}Pixware home page}}.
- Link to {{{https://www.pixware.fr}Secure Pixware home page}}.
- Link to {{{file:///tmp}Your temporary directory}}.
- Link to {{{ftp://ftp.apache.org}FTP file}}.
- Link to {{{mailto:dev at maven dot apache dot org}Maven dev ML}}.
-
- Force line\
- break.
-
- Non\ breaking\ space.
-
- Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.
-
- Copyright symbol: \251, \xA9, \u00a9.
-
-~~Commented out.
+%{snippet|id=skin-custom-config|file=${project.basedir}/src/site/site.xml}
Modified:
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/src/site/site.xml?rev=1201168&r1=1201167&r2=1201168&view=diff
==============================================================================
--- maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/src/site/site.xml
(original)
+++ maven/sandbox/trunk/skin/maven-fluido-skin/src/it/sidebar/src/site/site.xml
Sat Nov 12 02:31:39 2011
@@ -31,11 +31,13 @@
<version>${skinVersion}</version>
</skin>
+ <!-- START SNIPPET: skin-custom-config -->
<custom>
<fluidoSkin>
<searchEnabled>true</searchEnabled>
</fluidoSkin>
</custom>
+ <!-- END SNIPPET: skin-custom-config -->
<publishDate format="yyyy-MM-dd" position="right" />
<version position="right" />
Modified: maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/pom.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/pom.xml?rev=1201168&r1=1201167&r2=1201168&view=diff
==============================================================================
--- maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/pom.xml (original)
+++ maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/pom.xml Sat Nov 12
02:31:39 2011
@@ -29,7 +29,7 @@
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
- <name>@project.artifactId@ IT</name>
+ <name>@project.artifactId@ IT, topbar layout</name>
<url>http://maven.apache.org/skins/@project.artifactId@/topbar/</url>
<properties>
Modified:
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/src/site/apt/index.apt.vm?rev=1201168&r1=1201167&r2=1201168&view=diff
==============================================================================
---
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/src/site/apt/index.apt.vm
(original)
+++
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/src/site/apt/index.apt.vm
Sat Nov 12 02:31:39 2011
@@ -1,219 +1,16 @@
------
- ${skinName} test
+ ${project.name}
------
Hervé Boutemy
------
2011-10-15
------
-${skinName} test
+${project.name}
- This is a test for ${skinName}.
+ This is a test for ${skinName} with topbar enabled, sidebar disabled and
Google Search.
${skinDescription}
-* Usage
+* Actual configuration
- To use this skin in your project, use the skin element of
- {{{/doxia/doxia-sitetools/doxia-decoration-model/decoration.html}the
<<<site.xml>>> site descriptor}}:
-
-+-----+
-<project name="xxx">
- ...
- <skin>
- <groupId>${skinGroupId}</groupId>
- <artifactId>${skinArtifactId}</artifactId>
- <version>${skinVersion}</version>
- </skin>
- ...
-</project>
-+-----+
-
- The skin supports different layouts, enabling/disabling the left sidebar menu
and the topbar menu.
- Users have just play with flags in the <<<custom/fluidoSkin>>> element in
<<<site.xml>>>:
-
-+-----+
-<project name="xxx">
- ...
- <custom>
- <fluidoSkin>
- <topBarEnabled>true</topBarEnabled>
- <sideBarEnabled>false</sideBarEnabled>
- </fluidoSkin>
- </custom>
- ...
-</project>
-+-----+
-
- That allows users having 4 skins in only 1!
-
- [[1]] sidebar only;
-
- [[2]] topbar only;
-
- [[3]] both side/top bars;
-
- [[4]] none at all.
-
- Default skin setting is the option <<1>>.
-
- When users decide to enable the topbar, they can plug a small icon/logo there
(typically 108*20 px) just configuring
- the <<<custom/fluidoSkin/topBarIcon>>> element in <<<site.xml>>>:
-
-+-----+
-<project name="xxx">
- ...
- <custom>
- <fluidoSkin>
- <topBarEnabled>true</topBarEnabled>
- <topBarIcon>
- <name>Maven Fluido Skin</name>
- <alt>Maven Fluido Skin</alt>
- <src>/images/topbar-logo.png</src>
- <href>/index.html</href>
- </topBarIcon>
- </fluidoSkin>
- </custom>
- ...
-</project>
-+-----+
-
- Users can optionally enable the <<Google Search>> for the generated site,
requirements are:
-
- * the <<<project/url>>> property in <<<pom.xml>>>:
-
-+-----+
-<project>
-...
- <url>http://maven.apache.org/skins/${project.artifactId}</url>
-...
-</project>
-+-----+
-
- * the <<<custom/fluidoSkin/searchEnabled>>> element in <<<site.xml>>>:
-
-+-----+
-<project name="xxx">
- ...
- <custom>
- <fluidoSkin>
- <searchEnabled>true</searchEnabled>
- </fluidoSkin>
- </custom>
- ...
-</project>
-+-----+
-
- By default, the search form:
-
- * is <not> enabled;
- * is rendered in the sidebar, if the topbar only is available it will be
rendered there.
-
-Sample content
-
- 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
-+-------------------------------+
-
----------------------------------
-Verbatim text
- without box
----------------------------------
-
-[figure] 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
-*-----*------*
-
-*---------*---------*
-|| header || header |
-*---------*---------*
-| cell | cell |
-*---------*---------*
-
- Horizontal line:
-
-=======================================================================
-
- <Italic> font. <<Bold>> font. <<<Monospaced>>> font.
-
- {Anchor}. Link to {{Anchor}}.
- Link to {{{Anchor}showing alternate text}}.
- Link to {{{http://www.pixware.fr}Pixware home page}}.
- Link to {{{https://www.pixware.fr}Secure Pixware home page}}.
- Link to {{{file:///tmp}Your temporary directory}}.
- Link to {{{ftp://ftp.apache.org}FTP file}}.
- Link to {{{mailto:dev at maven dot apache dot org}Maven dev ML}}.
-
- Force line\
- break.
-
- Non\ breaking\ space.
-
- Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.
-
- Copyright symbol: \251, \xA9, \u00a9.
-
-~~Commented out.
+%{snippet|id=skin-custom-config|file=${project.basedir}/src/site/site.xml}
Modified:
maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/src/site/site.xml?rev=1201168&r1=1201167&r2=1201168&view=diff
==============================================================================
--- maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/src/site/site.xml
(original)
+++ maven/sandbox/trunk/skin/maven-fluido-skin/src/it/topbar/src/site/site.xml
Sat Nov 12 02:31:39 2011
@@ -31,6 +31,7 @@
<version>${skinVersion}</version>
</skin>
+ <!-- START SNIPPET: skin-custom-config -->
<custom>
<fluidoSkin>
<topBarEnabled>true</topBarEnabled>
@@ -44,6 +45,7 @@
<searchEnabled>true</searchEnabled>
</fluidoSkin>
</custom>
+ <!-- END SNIPPET: skin-custom-config -->
<publishDate format="yyyy-MM-dd" position="right" />
<version position="right" />
