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 2007/11/04 18:04:17 UTC
svn commit: r591803 -
/maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml
Author: dennisl
Date: Sun Nov 4 09:04:16 2007
New Revision: 591803
URL: http://svn.apache.org/viewvc?rev=591803&view=rev
Log:
[MSITE-159] Absolute URI rendered as relative URI if absolute URI related to domain of POM URI
Document the current beavior in the FAQ.
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml
Modified: maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml?rev=591803&r1=591802&r2=591803&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml Sun Nov 4 09:04:16 2007
@@ -21,14 +21,42 @@
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
- <faq id="How do I integrate static (x)html into my Maven site">
- <question>How do I integrate static (x)html into my Maven site?</question>
+ <faq id="How do I integrate static (x)html pages into my Maven site">
+ <question>How do I integrate static (x)html pages into my Maven site?</question>
<answer>
<p>
- You can integrate your static pages in this several steps:
- <br/> - Put your static pages in the resources directory, ${basedir}/src/site/resources.
- <br/> - Create your site.xml and put it in ${basedir}/src/site.
- <br/> - Link the static pages by modifying the menu section, create items and map it with the filename of the static pages.
+ You can integrate your static pages by following these steps:
+ </p>
+ <ul>
+ <li>Put your static pages in the resources directory, <code>${basedir}/src/site/resources</code></li>
+ <li>Create your <code>site.xml</code> and put it in <code>${basedir}/src/site</code></li>
+ <li>Link to the static pages by modifying the menu section, create items and map them to the filenames of the static pages</li>
+ </ul>
+ </answer>
+ </faq>
+ <faq id="Why do my absolute links get translated into relative links">
+ <question>Why do my absolute links get translated into relative links?</question>
+ <answer>
+ <p>
+ This happens because the site plugin tries to make all URLs relative,
+ when possible. If you have something like this defined in your
+ <code>pom.xml</code>:
+ <source>
+<url>http://www.your.site.com/</url></source>
+ and create links in your <code>site.xml</code> (just an example) like
+ this:
+ <source>
+<links>
+ <item name="Your Site" href="http://www.your.site.com/"/>
+ <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
+</links></source>
+ You will see that the link to 'Your site' will be a relative one, but
+ that the link to 'Maven 2' will be an absolute link.
+ </p>
+ <p>
+ There is an
+ <a href="http://jira.codehaus.org/browse/MSITE-159">issue for this in JIRA</a>,
+ where you can read more about this.
</p>
</answer>
</faq>