Author: xavier
Date: Thu Mar 1 05:58:52 2007
New Revision: 513325
URL: http://svn.apache.org/viewvc?view=rev&rev=513325
Log:
add more details to the write-doc page
Added:
incubator/ivy/core/trunk/doc/images/xooki-edit-small.png (with props)
incubator/ivy/core/trunk/doc/images/xooki-edit.png (with props)
incubator/ivy/core/trunk/doc/images/xooki-toolbar.png (with props)
Modified:
incubator/ivy/core/trunk/doc/write-doc.html
Added: incubator/ivy/core/trunk/doc/images/xooki-edit-small.png
URL:
http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/images/xooki-edit-small.png?view=auto&rev=513325
==============================================================================
Binary file - no diff available.
Propchange: incubator/ivy/core/trunk/doc/images/xooki-edit-small.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/ivy/core/trunk/doc/images/xooki-edit.png
URL:
http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/images/xooki-edit.png?view=auto&rev=513325
==============================================================================
Binary file - no diff available.
Propchange: incubator/ivy/core/trunk/doc/images/xooki-edit.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/ivy/core/trunk/doc/images/xooki-toolbar.png
URL:
http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/images/xooki-toolbar.png?view=auto&rev=513325
==============================================================================
Binary file - no diff available.
Propchange: incubator/ivy/core/trunk/doc/images/xooki-toolbar.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: incubator/ivy/core/trunk/doc/write-doc.html
URL:
http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/write-doc.html?view=diff&rev=513325&r1=513324&r2=513325
==============================================================================
--- incubator/ivy/core/trunk/doc/write-doc.html (original)
+++ incubator/ivy/core/trunk/doc/write-doc.html Thu Mar 1 05:58:52 2007
@@ -10,8 +10,18 @@
The documentation engine used is called <a
href="http://xooki.sourceforge.net";>xooki</a>, and allows to edit pages while
you browse them as soon as you browse them offline (and thus can actually save
your modifications).
-When you browse the doc offline (by checking out the [[svn:doc]] directory for
instance), 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. When you
choose edit you will see a pretty familiar textbox where you can edit the page
source.
+To browse the doc offline, we recommend to check it out from svn:
+<code>
+svn co https://svn.apache.org/repos/asf/incubator/ivy/core/trunk/doc ivy-doc
+</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>
+<br/><br/>
+When you choose edit you will see a pretty familiar textbox where you can edit
the page source.
+<center><a href="images/xooki-edit.png"><img
src="images/xooki-edit-small.png"/></a></center>
+<br/><br/>
The source uses a format very familiar to those who sometimes write html.
Indeed any html is allowed. But you also have some shortcuts and neat syntax.
First, line breaks are automatically recognized, so you don't have to put br
everywhere.
@@ -23,7 +33,8 @@
</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 easily 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 [[doc/reference]].
+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>
<script type="text/javascript">xooki.postProcess();</script>
