You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2010/08/12 23:36:39 UTC
svn commit: r984994 - in /maven/plugins/branches/maven-site-plugin-3.x: ./
src/site/fml/faq.fml
Author: dennisl
Date: Thu Aug 12 21:36:39 2010
New Revision: 984994
URL: http://svn.apache.org/viewvc?rev=984994&view=rev
Log:
Merge r984991 from trunk with modifications.
o Add FAQ about how the plugin uses the <url> element in the POM.
Modified:
maven/plugins/branches/maven-site-plugin-3.x/ (props changed)
maven/plugins/branches/maven-site-plugin-3.x/src/site/fml/faq.fml
Propchange: maven/plugins/branches/maven-site-plugin-3.x/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Thu Aug 12 21:36:39 2010
@@ -1 +1 @@
-/maven/plugins/trunk/maven-site-plugin:801155,801171,801470,806898-806906,807943-808180,809252,810298,884137,886844,886847,890094,890124,891014,891688,920027,920041,942622,943455,944145,950463,956681,984466,984960
+/maven/plugins/trunk/maven-site-plugin:801155,801171,801470,806898-806906,807943-808180,809252,810298,884137,886844,886847,890094,890124,891014,891688,920027,920041,942622,943455,944145,950463,956681,984466,984960,984991
Modified: maven/plugins/branches/maven-site-plugin-3.x/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/branches/maven-site-plugin-3.x/src/site/fml/faq.fml?rev=984994&r1=984993&r2=984994&view=diff
==============================================================================
--- maven/plugins/branches/maven-site-plugin-3.x/src/site/fml/faq.fml (original)
+++ maven/plugins/branches/maven-site-plugin-3.x/src/site/fml/faq.fml Thu Aug 12 21:36:39 2010
@@ -102,6 +102,23 @@ under the License.
</p>
</answer>
</faq>
+ <faq id="Use_of_url">
+ <question>How does the Site Plugin use the <url> element in the POM?</question>
+ <answer>
+ <p>
+ The Site Plugin uses the <url> element in the POM to create
+ relative links for the generated site. If your project has a URL
+ where the generated site is deployed, then put that URL into the
+ <url> element. If the project's site is not deployed anywhere,
+ then remove the <url> element from the POM.
+ </p>
+ <p>
+ In a multi module build it is important for the parent and child
+ modules to have <strong>different</strong> URLs. If they have the
+ same URL, then links within the combined site will not work.
+ </p>
+ </answer>
+ </faq>
</part>
<part id="Specific_issues">
<title>Specific issues</title>