You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by hi...@apache.org on 2017/06/30 14:15:12 UTC

[2/4] ant-ivy git commit: Review and cleanup of the "Ant tasks" part of the documentation

http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/25a67d80/asciidoc/use/var.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/var.adoc b/asciidoc/use/var.adoc
index 7566d34..61d20a3 100644
--- a/asciidoc/use/var.adoc
+++ b/asciidoc/use/var.adoc
@@ -17,29 +17,26 @@
    under the License.
 ////
 
-Sets a variable (by name and value), or set of variables (from file or url) in ivy. 
+Sets a variable (by name and value), or set of variables (from file or url) in Ivy.
 
 Variables are case sensitive.
 
-
 Contrary to ant properties, ivy variables are mutable. But a problem with this is that you do not control when 
 variables are substituted, and usually it is done as soon as possible. So changing the value of a variable will
 have no effect if it has already been substituted. Consequently, *using this task is NOT recommended*.
-See link:../reference.html[reference] page for details about ivy variables.
-
 
+See link:../reference.html[reference] page for details about Ivy variables.
 
-  
+== Attributes
 
 [options="header",cols="15%,50%,35%"]
 |=======
 |Attribute|Description|Required
 |name|the name of the variable to set|No
 |value|the value of the variable to set|Yes when using the name attribute
-|file|the filename of the property file to load as ivy variables|One of these, when *not* using the name attribute
+|file|the filename of the property file to load as ivy variables
+.2+.^|One of these, when *not* using the name attribute
 |url|the url from which to read ivy variables
-|prefix|Prefix to apply to variables. A "." is appended to the prefix if not specified.|No
-|settingsRef|A reference to the ivy settings that must be used by this task *__(since 2.0)__*|No, 'ivy.instance' is taken by default.
+|prefix|Prefix to apply to variables. A dot (`.`) is appended to the prefix if not specified.|No
+|settingsRef|A reference to the ivy settings that must be used by this task *__(since 2.0)__*|No, defaults to `ivy.instance`.
 |=======
-
-

http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/25a67d80/asciidoc/yed.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/yed.adoc b/asciidoc/yed.adoc
index ea307d4..095c7de 100644
--- a/asciidoc/yed.adoc
+++ b/asciidoc/yed.adoc
@@ -20,36 +20,32 @@
 link:http://www.yworks.com/en/products_yed_about.htm[yEd] is a free graph editor, benefiting from
 all the automatic layouts of yFiles. Ivy is able to generate graphs which are readable by yEd.
 
-The graphs generated by ivy are not layed out (in fact it's why we use yEd), so you have to follow a simple sequence of steps to layout the generated graphs.
-
+The graphs generated by Ivy are not layed out (in fact it's why we use yEd), so you have to follow a simple sequence of steps to layout the generated graphs.
 
 == Preparation
 
 First you have to generate a graphml file. Simply call the report task (see ivy use documentation) for that.
 
-
 == Step 1: open the graphml file
 
 Launch yEd editor, and open the graphml file generated by the report task. You should obtain something like this:
 
 image::images/yed-step1.jpg[]
 
-
-
 == Step 2: ask yEd to adjust nodes size
 
-
 image::images/yed-step2.jpg[]
-image::images/yed-step3.jpg[]
-image::images/yed-step3-2.jpg[]
 
+image::images/yed-step3.jpg[]
 
+image::images/yed-step3-2.jpg[]
 
 == Step 3: ask yEd to layout nodes
 
-
 image::images/yed-step4.jpg[]
+
 image::images/yed-step5.jpg[]
+
 image::images/yed-step6.jpg[]
 
 That's all, you should have obtained something like this:
@@ -58,6 +54,3 @@ image::images/yed-step7.jpg[]
 
 Note that this is only one possibility, test the available layouts yourself, you could find one better in your case.
 Once you have layed out the graph, you can either save it with in the same file (but be warned that it will be overwritten at next ivy report call), or another file, export it to jpg, gif, svg, etc. (see link:http://www.yworks.com/en/products_yed_about.htm[yEd] site for details).
-
-
-