Author: hibou
Date: Thu May 8 08:40:13 2008
New Revision: 654559
URL: http://svn.apache.org/viewvc?rev=654559&view=rev
Log:
Start the refactoring of IvyDE documentation:
- separation of documentation and site
- handle versioned documentation
- make the TOC look like Ivy site and documentation
Added:
ant/ivy/ivyde/site/ (with props)
ant/ivy/ivyde/site/config.json
- copied unchanged from r654061, ant/ivy/ivyde/trunk/doc/config.json
ant/ivy/ivyde/site/download.html
- copied unchanged from r654061, ant/ivy/ivyde/trunk/doc/download.html
ant/ivy/ivyde/site/get-involved.html (with props)
ant/ivy/ivyde/site/history/ (with props)
ant/ivy/ivyde/site/history.html (with props)
ant/ivy/ivyde/site/images/
- copied from r654061, ant/ivy/ivyde/trunk/doc/images/
ant/ivy/ivyde/site/index.html
- copied, changed from r654061, ant/ivy/ivyde/trunk/doc/index.html
ant/ivy/ivyde/site/issues.html
- copied unchanged from r654061, ant/ivy/ivyde/trunk/doc/issues.html
ant/ivy/ivyde/site/mailing-lists.html (with props)
ant/ivy/ivyde/site/style/
- copied from r654061, ant/ivy/ivyde/trunk/doc/style/
ant/ivy/ivyde/site/template.html
- copied, changed from r654061, ant/ivy/ivyde/trunk/doc/template.html
ant/ivy/ivyde/site/toc.json
- copied, changed from r654061, ant/ivy/ivyde/trunk/doc/toc.json
Propchange: ant/ivy/ivyde/site/
------------------------------------------------------------------------------
--- svn:externals (added)
+++ svn:externals Thu May 8 08:40:13 2008
@@ -0,0 +1,2 @@
+xooki https://svn.apache.org/repos/asf/ant/ivy/site/xooki/
+
Added: ant/ivy/ivyde/site/get-involved.html
URL:
http://svn.apache.org/viewvc/ant/ivy/ivyde/site/get-involved.html?rev=654559&view=auto
==============================================================================
--- ant/ivy/ivyde/site/get-involved.html (added)
+++ ant/ivy/ivyde/site/get-involved.html Thu May 8 08:40:13 2008
@@ -0,0 +1,43 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd";>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<html>
+<head>
+ <script type="text/javascript">var xookiConfig = {level: 0};</script>
+ <script type="text/javascript" src="xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+As an Apache project, IvyDE is very open to external contributions.
+
+There are many ways to contribute to IvyDE.
+
+First, [[download]] and use it, subscribe to the [[mailing-lists]], and answer
to other user questions. You can also browse [[issues jira issues]], vote for
the one you are most interested in, add your comments and feedback. You can
also very easily contribute to the [[wiki]].
+
+When you browse the documentation, whenever you see something that could be
improved, feel free to edit it and provide a documentation patch. It's very
easy if you browse the documentation offline (in the doc directory if you check
out IvyDE from svn), you will see a small toolbar at the upper left of the
page, which allows you to edit the page. Then all you have to do is attach your
modification as a patch to a new issue in JIRA.
+<i>If you are interested in contributing documentation, read [[write-doc this
page]].</i>
+
+You can also provide brand new documentation pages, tutorials, demo, or even
links to a tutorial on your own blog.
+
+When you get more confident with IvyDE, you can check it out from svn, and
begin to see if there are issues you could fix or implement, and provide
patches to make the whole community benefit from your work.
+
+And if you often provide patches and answers on the mailing lists, you may get
the chance to become a commiter, with write access to the svn
repository!</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: ant/ivy/ivyde/site/get-involved.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ant/ivy/ivyde/site/get-involved.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: ant/ivy/ivyde/site/get-involved.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Propchange: ant/ivy/ivyde/site/history/
------------------------------------------------------------------------------
--- svn:externals (added)
+++ svn:externals Thu May 8 08:40:13 2008
@@ -0,0 +1,4 @@
+trunk https://svn.apache.org/repos/asf/ant/ivy/ivyde/trunk/doc
+latest-milestone
https://svn.apache.org/repos/asf/ant/ivy/ivyde/branches/1.2.0/doc
+1.2.0 https://svn.apache.org/repos/asf/ant/ivy/ivyde/branches/1.2.0/doc
+
Added: ant/ivy/ivyde/site/history.html
URL:
http://svn.apache.org/viewvc/ant/ivy/ivyde/site/history.html?rev=654559&view=auto
==============================================================================
--- ant/ivy/ivyde/site/history.html (added)
+++ ant/ivy/ivyde/site/history.html Thu May 8 08:40:13 2008
@@ -0,0 +1,35 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd";>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<html>
+<head>
+ <script type="text/javascript">var xookiConfig = {level: 0};</script>
+ <script type="text/javascript" src="xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+You can find here the whole history of IvyDE versions.
+
+The history is decomposed in streams, corresponding to major versions.
+
+Versions prior to 2.x were released by Jayasoft, and are not endorsed by the
Apache Software Foundation.
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: ant/ivy/ivyde/site/history.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ant/ivy/ivyde/site/history.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: ant/ivy/ivyde/site/history.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Copied: ant/ivy/ivyde/site/index.html (from r654061,
ant/ivy/ivyde/trunk/doc/index.html)
URL:
http://svn.apache.org/viewvc/ant/ivy/ivyde/site/index.html?p2=ant/ivy/ivyde/site/index.html&p1=ant/ivy/ivyde/trunk/doc/index.html&r1=654061&r2=654559&rev=654559&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/index.html (original)
+++ ant/ivy/ivyde/site/index.html Thu May 8 08:40:13 2008
@@ -24,44 +24,12 @@
</head>
<body>
<textarea id="xooki-source">
-Integrate Ivy in Eclipse with the IvyDE plugin.<br/>
-IvyDE can be considered as the merge of two tools:
-<ul>
-<li><a href="editor.html">Ivy xml files Editor</a>: creation wizard, html
preview and completion for Ivy xml tag, attributes but also attributes'
values.</li>
-<li><a href="cp_container.html">Class path container</a>: Automatic downloads,
access "resolve" task from your IDE</li>
-</ul>
-
-<h1>Content</h1>
-<ul>
-<li><a href="#install">Installation</a></li>
-<li><a href="#pref">Eclipse Preference</a></li>
-<li><a href="#project_pref">Project Preference</a></li>
-</ul>
-
-<h1><a name="install">Plugin installation</a></h1>
-IvyDE has not yet been released within the Apache Software Foundation. For the
moment you can use the old location of IvyDE for installation:
-<ul>
-<li>the update site : http://update.jayasoft.org/ </li>
-<li><a href="download.html">download</a> the binaries and unzip it in your
eclipse root folder</li>
-</ul>
-
-<h1><a name="pref">Eclipse Preference Page</a></h1>
-<img src="images/pref.jpg"/><br/><br/><br/>
-<ol><b>Preference fields:</b>
- <li> Ivyconf URL : specify here the path to your ivyconf file. Leave it
blank to use ivy default resolvers</li>
- <li> Retrieve option : specify here if you want ivy to do a retrieve
after the resolve.<br/> If you check retrieve you must provide a the retreive
pattern. Check <a href="ivy/doc/use/retrieve.html">ivy documentation</a> for
pattern explanation.
-
-</li>
- <li> Organisation: your company name for ivy editor completion </li>
- <li> Organisation Url: your company web site url for ivy editor
completion </li>
-</ol>
-
-<h1><a name="project_pref">Project Preference Page</a></h1>
-<img src="images/project_pref.jpg"/><br/><br/><br/>
-<ol><b>Preference fields:</b>
- <li> URL : specify here the path to your ivyconf file in scope of
project. Leave it blank to use ivyconf file defined in eclipse properties (see
<a href="ivyde.html#pref">eclipse properties</a>) or use "default" to use ivy
default resolvers</li>
-</ol>
-</textarea>
+<p>
+Integrate Ivy in Eclipse with the IvyDE plugin.
+</p>
+<p>
+IvyDE lets you manage your dependencies declared in an ivy.xml in your Java
Eclipse projects. IvyDE will contribute to the classpath of your Java project,
with the [[cp_container classpath container]]. It also bring an [[editor
editor]] of ivy.xml files, with completion.
+</p></textarea>
<script type="text/javascript">xooki.postProcess();</script>
</body>
</html>
Added: ant/ivy/ivyde/site/mailing-lists.html
URL:
http://svn.apache.org/viewvc/ant/ivy/ivyde/site/mailing-lists.html?rev=654559&view=auto
==============================================================================
--- ant/ivy/ivyde/site/mailing-lists.html (added)
+++ ant/ivy/ivyde/site/mailing-lists.html Thu May 8 08:40:13 2008
@@ -0,0 +1,35 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd";>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<html>
+<head>
+ <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
+ <script type="text/javascript">var xookiConfig = {level: 0};</script>
+ <script type="text/javascript" src="xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+Before posting to mailing lists, make sure you don't have the answer to your
question in the [[faq]] or more generally in the
[[history/latest-milestone/index documentation]].
+
+Actually there is no IvyDE specific mailing lists. Every discussion about
IvyDE is part of the Ivy mailing lists. So if you have any question about the
use of IvyDE, use [EMAIL PROTECTED] About the development use [EMAIL PROTECTED]
And to get the subversion and Jira notifications, subscribe to [EMAIL PROTECTED]
+
+For further information about these mailing lists, see [[../mailing-lists Ivy
mailing list page]].</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: ant/ivy/ivyde/site/mailing-lists.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ant/ivy/ivyde/site/mailing-lists.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: ant/ivy/ivyde/site/mailing-lists.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Copied: ant/ivy/ivyde/site/template.html (from r654061,
ant/ivy/ivyde/trunk/doc/template.html)
URL:
http://svn.apache.org/viewvc/ant/ivy/ivyde/site/template.html?p2=ant/ivy/ivyde/site/template.html&p1=ant/ivy/ivyde/trunk/doc/template.html&r1=654061&r2=654559&rev=654559&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/template.html (original)
+++ ant/ivy/ivyde/site/template.html Thu May 8 08:40:13 2008
@@ -90,6 +90,8 @@
<div class="primary-links">::
<a href="index.html">Home</a> ::
<a href="download.html">Download</a> ::
+ <a href="documentation.html">Documentation</a> ::
+ <a href="get-involved.html">Get involved</a> ::
</div>
</td>
</tr>
Copied: ant/ivy/ivyde/site/toc.json (from r654061,
ant/ivy/ivyde/trunk/doc/toc.json)
URL:
http://svn.apache.org/viewvc/ant/ivy/ivyde/site/toc.json?p2=ant/ivy/ivyde/site/toc.json&p1=ant/ivy/ivyde/trunk/doc/toc.json&r1=654061&r2=654559&rev=654559&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/toc.json (original)
+++ ant/ivy/ivyde/site/toc.json Thu May 8 08:40:13 2008
@@ -4,6 +4,25 @@
"id":"index",
"title":"Home",
"children": [
+
+ ]
+ },
+ {
+ "id":"download",
+ "title":"Download",
+ "children": [
+
+ ]
+ },
+ {
+ "title":"Documentation",
+ "importRoot":"history/latest-milestone",
+ "importNode":"index"
+ },
+ {
+ "id":"documentation",
+ "title":"Documentation",
+ "children": [
{
"id":"editor",
"title":"Editor",
@@ -28,18 +47,40 @@
]
},
{
- "id":"download",
- "title":"Download",
+ "id":"history",
+ "title":"History",
"children": [
-
+ {
+ "title":"trunk",
+ "importRoot":"history/trunk",
+ "importNode":"index"
+ },
+ {
+ "title":"1.2.0",
+ "importRoot":"history/1.2.0",
+ "importNode":"index"
+ }
]
},
{
- "id":"issues",
- "title":"Issue Tracking",
+ "id":"get-involved",
+ "title":"Get Involved",
"children": [
+ {
+ "id":"mailing-lists",
+ "title":"Mailing Lists",
+ "children": [
+ ]
+ },
+ {
+ "id":"issues",
+ "title":"Issue Tracking",
+ "children": [
+
+ ]
+ }
]
}
]
-}
+}
\ No newline at end of file
