natas_hw
/
ant-ivy
mirror of https://github.com/apache/ant-ivy
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add more details to the write-doc page 

git-svn-id: https://svn.apache.org/repos/asf/incubator/ivy/core/trunk@513325 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Xavier Hanin 2007-03-01 13:58:52 +00:00
parent 7be496a1c5
commit 77a7c40720
4 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/images/xooki-edit-small.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 29 KiB

BIN
doc/images/xooki-edit.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 52 KiB

BIN
doc/images/xooki-toolbar.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.4 KiB

15
doc/write-doc.html
View File

@ -10,8 +10,18 @@ Writing documentation for Ivy is pretty simple.
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 @@ any text including <tags/>
</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>