Author: xavier
Date: Fri Jul 6 02:32:31 2007
New Revision: 553815
URL: http://svn.apache.org/viewvc?view=rev&rev=553815
Log:
- add publish site target in build.xml + ivyde site generation
- fix links in templates
- slight review of write doc page (including some links fix)
- replace config.json by config.js
Added:
incubator/ivy/site/config.js (with props)
Removed:
incubator/ivy/site/config.json
Modified:
incubator/ivy/core/trunk/doc/template.html
incubator/ivy/site/build.xml
incubator/ivy/site/template.html
incubator/ivy/site/write-doc.html
Modified: incubator/ivy/core/trunk/doc/template.html
URL:
http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/template.html?view=diff&rev=553815&r1=553814&r2=553815
==============================================================================
--- incubator/ivy/core/trunk/doc/template.html (original)
+++ incubator/ivy/core/trunk/doc/template.html Fri Jul 6 02:32:31 2007
@@ -20,7 +20,7 @@
<html xmlns="http://www.w3.org/1999/xhtml"; lang="en" xml:lang="en">
<head>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
-<title>${title} | Ivy</title>
+<title>${title} | Ivy Documentation</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="js/jquery.pack.js" type="text/javascript"></script>
@@ -76,8 +76,6 @@
<h1 class="title">${title}</h1>
${body}
- <hr/>
- <a href="${printerFriendlyLocation}">Printer Friendly</a>
</div><!-- main -->
</td>
</tr>
@@ -89,10 +87,9 @@
<td align="center" valign="middle">
<div class="primary-links">::
<a href="index.html">Home</a> ::
- <a href="download.html">Download</a> ::
- <a href="doc.html">Documentation</a> ::
- <a href="doc/tutorial.html">Tutorials</a> ::
- <a href="get-involved.html">Get Involved</a> ::
+ <a href="reference.html">Reference</a> ::
+ <a href="tutorial.html">Tutorials</a> ::
+ <a href="dev.html">Developer's doc</a> ::
</div>
</td>
</tr>
Modified: incubator/ivy/site/build.xml
URL:
http://svn.apache.org/viewvc/incubator/ivy/site/build.xml?view=diff&rev=553815&r1=553814&r2=553815
==============================================================================
--- incubator/ivy/site/build.xml (original)
+++ incubator/ivy/site/build.xml Fri Jul 6 02:32:31 2007
@@ -23,23 +23,51 @@
<target name="generate-site" depends="init-imported-history"
description="--> Generates site for publication">
+ <!-- xooki:generate requires sun java 6 jdk (with jrunscript)
in path and Apache Ant 1.7 -->
<copy todir="${target.dir}">
<fileset dir="${basedir}"
includes="images/**,style/**,samples/**,js/**" />
</copy>
- <!-- requires java 6 jdk in path and Apache Ant 1.7 -->
<xooki:generate destDir="${target.dir}" checkUpToDate="true">
<fileset dir="${basedir}">
<include name="**/*.html"/>
- <exclude name="template.html"/>
- <exclude name="*Template.html"/>
+ <exclude name="**/template.html"/>
+ <exclude name="**/*Template.html"/>
<exclude name="presentations/**"/>
<exclude name="samples/**"/>
<exclude name="js/**"/>
<exclude name="**/xooki/**"/>
<exclude name="target/**"/>
+ <exclude name="ivyde/**"/>
+ </fileset>
+ </xooki:generate>
+ <!-- ivyde site is a separate site, we generate it separately -->
+ <copy todir="${target.dir}/ivyde">
+ <fileset dir="${basedir}/ivyde" includes="images/**,style/**" />
+ </copy>
+ <xooki:generate destDir="${target.dir}/ivyde" checkUpToDate="true">
+ <fileset dir="${basedir}/ivyde">
+ <include name="**/*.html"/>
+ <exclude name="template.html"/>
+ <exclude name="*Template.html"/>
+ <exclude name="**/xooki/**"/>
</fileset>
</xooki:generate>
</target>
+
+ <target name="publish-site"
+ description="--> generate site and upload it to
people.apache.org server (requires an apache account)">
+ <property name="host.name" value="people.apache.org" />
+ <echo message="Preparing to upload site to ${host.name}..." />
+ <input addproperty="username" message="Please enter username:"
/>
+ <input addproperty="password" message="Please enter password:"
/>
+
+ <antcall target="generate-site" />
+
+ <scp todir="${username}:[EMAIL
PROTECTED]:/www/incubator.apache.org/ivy/"
+ trust="true" verbose="true" sftp="true">
+ <fileset dir="${target.dir}"/>
+ </scp>
+ </target>
<target name="clean" description="--> clean generated site">
<delete dir="${target.dir}" />
Added: incubator/ivy/site/config.js
URL:
http://svn.apache.org/viewvc/incubator/ivy/site/config.js?view=auto&rev=553815
==============================================================================
--- incubator/ivy/site/config.js (added)
+++ incubator/ivy/site/config.js Fri Jul 6 02:32:31 2007
@@ -0,0 +1,7 @@
+xooki.util.mix({debug:true,
+ jira: {ids: ['IVY'], url: 'http://issues.apache.org/jira'},
+ shortcuts: {
+ svn: {pre:
'https://svn.apache.org/repos/asf/incubator/ivy/core/trunk/'},
+ ant: {pre: xooki.c.relativeRoot+'use/', post:'.html'}
+ }
+}, xooki.c, false);
Propchange: incubator/ivy/site/config.js
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/ivy/site/template.html
URL:
http://svn.apache.org/viewvc/incubator/ivy/site/template.html?view=diff&rev=553815&r1=553814&r2=553815
==============================================================================
--- incubator/ivy/site/template.html (original)
+++ incubator/ivy/site/template.html Fri Jul 6 02:32:31 2007
@@ -76,8 +76,6 @@
<h1 class="title">${title}</h1>
${body}
- <hr/>
- <a href="${printerFriendlyLocation}">Printer Friendly</a>
</div><!-- main -->
</td>
</tr>
@@ -90,8 +88,7 @@
<div class="primary-links">::
<a href="index.html">Home</a> ::
<a href="download.html">Download</a> ::
- <a href="doc.html">Documentation</a> ::
- <a href="doc/tutorial.html">Tutorials</a> ::
+ <a href="history/trunk/index.html">Documentation</a> ::
<a href="get-involved.html">Get Involved</a> ::
</div>
</td>
Modified: incubator/ivy/site/write-doc.html
URL:
http://svn.apache.org/viewvc/incubator/ivy/site/write-doc.html?view=diff&rev=553815&r1=553814&r2=553815
==============================================================================
--- incubator/ivy/site/write-doc.html (original)
+++ incubator/ivy/site/write-doc.html Fri Jul 6 02:32:31 2007
@@ -33,6 +33,13 @@
<code>
svn co https://svn.apache.org/repos/asf/incubator/ivy/core/trunk/doc ivy-doc
</code>
+
+Alternatively you can also check out the whole site:
+<code>
+svn co https://svn.apache.org/repos/asf/incubator/ivy/site ivy-site
+</code>
+
+
Then open the index.html file, and you will browse the web site exactly as
when you're online, except that you will see a small toolbar at the uper right,
allowing to edit the page, save it, move the page in the TOC, create a child,
and so on:
<center><img src="images/xooki-toolbar.png"/></center>
@@ -52,10 +59,11 @@
</code>
Very helpful to avoid escaping all xml with lt and gt.
-Finally, URLs are automatically recognized and convert to links, jira issues
like IVY-202 are recognized too, and you can use a neat format to reference any
ant ivy ant task like [[ant:import]], or also reference svn page easily like
[[svn:build.xml this link to build.xml]]. And you can also link to another page
by providing its id (i.e. its url without the base and the .html) like the
[[index]] or the [[doc/reference]].
+Finally, URLs are automatically recognized and convert to links, jira issues
like IVY-202 are recognized too, and you can use a neat format to reference any
ant ivy ant task like [[ant:import]], or also reference svn page easily like
[[svn:build.xml this link to build.xml]]. And you can also link to another page
by providing its id (i.e. its url without the base and the .html) like the
[[index]] or the [[history/trunk/index]].
+
Feel free to edit this page to get a good overview of what is possible.
-And do not forget to save your changes before the page! Then you can use your
favorite IDE and compute a patch for what you changed, and submit this patch by
attaching it to a jira issue, or simply sending it to the ivy-dev
[[mailing-lists mailing list]].</textarea>
+And do not forget to save your changes before leaving the page! Then you can
use your favorite IDE or svn and compute a patch for what you changed, and
submit this patch by attaching it to a jira issue, or simply sending it to the
ivy-dev [[mailing-lists mailing list]].</textarea>
<script type="text/javascript">xooki.postProcess();</script>
</body>
</html>
