You are viewing a plain text version of this content. The canonical link for it is here.
Posted to ivy-commits@incubator.apache.org by xa...@apache.org on 2007/07/06 09:08:40 UTC
svn commit: r553802 - in /incubator/ivy/core/trunk/doc: index.html
intro.html reference.html toc.json tutorial.html
Author: xavier
Date: Fri Jul 6 02:08:37 2007
New Revision: 553802
URL: http://svn.apache.org/viewvc?view=rev&rev=553802
Log:
review introduction pages
Removed:
incubator/ivy/core/trunk/doc/intro.html
Modified:
incubator/ivy/core/trunk/doc/index.html
incubator/ivy/core/trunk/doc/reference.html
incubator/ivy/core/trunk/doc/toc.json
incubator/ivy/core/trunk/doc/tutorial.html
Modified: incubator/ivy/core/trunk/doc/index.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/index.html?view=diff&rev=553802&r1=553801&r2=553802
==============================================================================
--- incubator/ivy/core/trunk/doc/index.html (original)
+++ incubator/ivy/core/trunk/doc/index.html Fri Jul 6 02:08:37 2007
@@ -34,43 +34,46 @@
<li>tight integration with Apache Ant - while available as a standalone tool, Ivy works particularly well with Apache Ant providing a number of powerful Ant tasks ranging from dependency resolution to dependency reporting and publication.</li>
</ol>
-Ivy is open source and released under a very permissive <a href="license.html">license</a>.
-Ivy has a lot of powerful [[features]], the most popular and useful being its flexibily, integration with ant, and its strong transitive dependencies management engine.
-The transitive dependencies management is a feature which let you get dependencies of your dependencies, transitively. In order to address this problematic ivy needs to find metadata about your modules, usually in an <a href="doc/ivyfile.html">ivy file</a>. To find these metadata and your dependencies artifacts (usually jars), Ivy can be configured to use a lot of different <a href="doc/configuration/resolvers.html">repositories</a>.
+Ivy is open source and released under a very permissive <a href="license.html">Apache License</a>.
+
+Ivy has a lot of powerful [[features]], the most popular and useful being its flexibility, integration with ant, and its strong transitive dependencies management engine.
+
+The transitive dependencies management is a feature which let you get dependencies of your dependencies, transitively. In order to address this problematic ivy needs to find metadata about your modules, usually in an <a href="ivyfile.html">ivy file</a>. To find these metadata and your dependencies artifacts (usually jars), Ivy can be configured to use a lot of different <a href="configuration/resolvers.html">repositories</a>.
<h1>About this doc</h1>
+<div class="postit" style="width: 250px;">
+Tip: The menu on the left is dynamic, you can click on the arrows to browse the menu without going to each page.
+</div>
This documentation has been migrated from the old Ivy web site hosted by Jayasoft, feel free to report any problem on the [[mailing-lists]].
-If you browse this documentation from your installation of ivy, you can also check the <a href="http://incubator.apache.org/ivy/doc.html">online version</a> for latest updates.
+If you browse this documentation from your installation of Ivy, you can also check the <a href="http://incubator.apache.org/ivy/">online version</a> for latest updates.
You can also browse this documentation offline either by downloading the documentation distribution, or by checking out the doc directory from svn. This documentation uses <a href="http://xooki.sourceforge.net/">xooki</a> as documentation engine, so you can very easily [[get-involved edit it and submit patches]] when you browse it from source.
-The online version of this documentation is updated periodically, especially when new features are added during development. So if you find something documented here not available in your version of ivy, it may be because it is available only with the latest <a href="download.html">download</a>.
+Since Ivy [[history/2.0.0-alpha-2 2.0.0-alpha-2]], we keep an online history of the documentation. You can thus browse history versions online (in the history menu in the web site) and even check the trunk version documentation currently in development.
-If you want to view the whole documentation in a single printer-friendly page, please use the <a href="doc.html?action=print">printer-friendly link</a> at the bottom of any documentation page in the online documentation, and you will get a printer friendly version of the current page and all its sub pages.
+For earlier versions, we suggest downloading the documentation to browse the documentation corresponding to the version you use. The full history of Ivy versions with corresponding links for download is available in the history menu on the web site.
<h1>Other places to go</h1>
-Check Ivy <a href="features.html">features</a>.
-Read our <a href="faq.html">FAQ</a>.
-Ask for help on our <a href="mailing-lists.html">mailing lists</a>.
-Report bug or feature request in our <a href="issues.html">issue tracking system</a>.
-Check <a href="links.html">external tools and resources</a>.
+Check Ivy [[features features]].
+Read our [[faq FAQ]].
+Ask for help on our [[mailing-lists mailing lists]].
+Report bug or feature request in our [[issues issue tracking system]].
+Check [[links external tools and resources]].
<h1>Overview</h1>
This documentation is decomposed in 3 main parts:
<ul>
<li>[[tutorial]]</li>
The tutorials is the best way to begin to play with ivy. You will easily and quickly learn the basics of Ivy.
- <li><a href="doc/reference.html">Reference</a></li>
+ <li>[[reference]]</li>
The reference documentation gives you all the details of Ivy.
The introduction part is particularly useful: it defines some vocabulary, explains main concepts such as dependency resolvers and patterns, and give an overview on how ivy works internally.
It's also in the reference doc that you will find all you always dreamed to know about ivy configuration, ivy files, and ivy use (especially with ant).
- <li><a href="doc/appendix.html">Appendix</a></li>
-The appendix section contains a bunch of Ivy related information which is not part of Ivy reference doc.
+ <li>[[dev]]</li>
+The developers's doc is useful for users who would like to extend Ivy or build it from source. It's also the documentation used by the Ivy team, so you will also find information about how we make releases.
</ul>
-
-You will also find here interesting pages like [[bestpractices]], the [[faq]] or the [[links]] pages.
- </textarea>
+</textarea>
<script type="text/javascript">xooki.postProcess();</script>
</body>
</html>
Modified: incubator/ivy/core/trunk/doc/reference.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/reference.html?view=diff&rev=553802&r1=553801&r2=553802
==============================================================================
--- incubator/ivy/core/trunk/doc/reference.html (original)
+++ incubator/ivy/core/trunk/doc/reference.html Fri Jul 6 02:08:37 2007
@@ -25,7 +25,33 @@
</head>
<body>
<textarea id="xooki-source">
- </textarea>
+Welcome to Ivy reference documentation!
+
+If you don't know Ivy at all, give a glance at its [[features features]], the [[faq]] and the [[tutorial tutorials]] before digging into this reference documentation.
+
+<h1>Reference Overview</h1>
+This documentation is decomposed in several parts:
+<ul>
+<li>Introduction</li>
+<ul>
+<li>[[terminology]]</li>
+This part gives you the meaning of some words used all over ivy doc, such as organisation, module, configurations, settings, ...
+<li>[[concept]]</li>
+This part introduces the main concepts used in Ivy: dependency resolvers, variables, patterns, and also a good introduction to a central ivy concept: module configurations.
+<li>[[principle]]</li>
+As the title suggest, here you will have some explanations on how does ivy work internally, which can help to better understand and customize its use.
+<li>[[install]]</li>
+This part describe how to install Ivy
+</ul>
+<li>[[configuration]]</li>
+This part is dedicated to the specification of the settings file of Ivy (usually called ivysettings.xml). It also gives the list of built-in dependency resolvers available in ivy.
+<li>[[ivyfile]]</li>
+This part is the reference of the specification of the ivy files, the files in which you describe your dependencies. If you have any question of what can be done or not in an ivy file, you will have the answer here.
+<li>[[ant]]</li>
+This part describes how to use ivy from ant. It's in this section that all ant tasks brought by ivy are specified.
+<li>[[standalone]]</li>
+Even though Ivy is most often used from ant, it can also be used from the command line. This page describes how you can do it.
+</ul></textarea>
<script type="text/javascript">xooki.postProcess();</script>
</body>
</html>
Modified: incubator/ivy/core/trunk/doc/toc.json
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/toc.json?view=diff&rev=553802&r1=553801&r2=553802
==============================================================================
--- incubator/ivy/core/trunk/doc/toc.json (original)
+++ incubator/ivy/core/trunk/doc/toc.json Fri Jul 6 02:08:37 2007
@@ -107,6 +107,7 @@
{
"id":"intro",
"title":"Introduction",
+ "isAbstract":true,
"children": [
{
"id":"terminology",
@@ -720,5 +721,5 @@
}
]
}
- ]
+ ]
}
Modified: incubator/ivy/core/trunk/doc/tutorial.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/tutorial.html?view=diff&rev=553802&r1=553801&r2=553802
==============================================================================
--- incubator/ivy/core/trunk/doc/tutorial.html (original)
+++ incubator/ivy/core/trunk/doc/tutorial.html Fri Jul 6 02:08:37 2007
@@ -33,7 +33,7 @@
<li>copy <a href="../samples/build.xml">this build file</a> in an empty directory on your local filesystem (and make sure you name it build.xml)</li>
<li>open a console in this directory and run "ant". That's it!</li>
</ul>
-If you have any trouble, check the <a href="../faq.html">FAQ</a>, it may be related to your internet connection (proxy anyone?).
+If you have any trouble, check the <a href="../../faq.html">FAQ</a>, it may be related to your internet connection (proxy anyone?).
OK, you've seen how easy it is to make your first step with ivy? Go ahead with the other tutorials, but before make sure you have properly <a href="install.html">installed</a> ivy and downloaded the tutorials sources (included in all ivy distributions, in the [[svn:src/example]] directory).