Add documentation concerning xlabels

diff --git a/ChangeLog b/ChangeLog
index e39ffec9a115d9836ae59bd8f9ab84a001bafb5f..db314459d8e462cb861deb0d5943ec250780c834 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,5 @@
+August 3, 2011
+    - Add support for external labels
 July 14, 2011
     - Add initial implementation of graphml2gv
 July 8, 2011

diff --git a/doc/info/attrs.html b/doc/info/attrs.html
index 9a80e48b18c530602338a74fdd18bf1cf11059d9..4f629e14b1230e42f13f8c15d1f780f3fb3b5789 100644 (file)
--- a/doc/info/attrs.html
+++ b/doc/info/attrs.html
@@ -180,6 +180,9 @@ This field indicates which graph component uses the attribute.
 </TD><TD>G</TD><TD>string</TD><TD ALIGN="CENTER">system-dependent</TD><TD></TD><TD></TD> </TR>
  <TR><TD><A NAME=a:fontsize HREF=#d:fontsize>fontsize</A>
 </TD><TD>ENGC</TD><TD>double</TD><TD ALIGN="CENTER">14.0</TD><TD>1.0</TD><TD></TD> </TR>
+ <TR><TD><A NAME=a:forcelabels HREF=#d:forcelabels>forcelabels</A>
+</TD><TD>G</TD><TD><A HREF=#k:bool>bool</A>
+</TD><TD ALIGN="CENTER">false</TD><TD></TD><TD></TD> </TR>
  <TR><TD><A NAME=a:group HREF=#d:group>group</A>
 </TD><TD>N</TD><TD>string</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD>dot only</TD> </TR>
  <TR><TD><A NAME=a:headURL HREF=#d:headURL>headURL</A>
@@ -476,6 +479,9 @@ This field indicates which graph component uses the attribute.
 </TD><TD>E</TD><TD>double</TD><TD ALIGN="CENTER">1.0</TD><TD>0(dot)<BR>1(neato,fdp,sfdp)</TD><TD></TD> </TR>
  <TR><TD><A NAME=a:width HREF=#d:width>width</A>
 </TD><TD>N</TD><TD>double</TD><TD ALIGN="CENTER">0.75</TD><TD>0.01</TD><TD></TD> </TR>
+ <TR><TD><A NAME=a:xlabel HREF=#d:xlabel>xlabel</A>
+</TD><TD>EN</TD><TD><A HREF=#k:lblString>lblString</A>
+</TD><TD ALIGN="CENTER">""</TD><TD></TD><TD></TD> </TR>
  <TR><TD><A NAME=a:z HREF=#d:z>z</A>
 </TD><TD>N</TD><TD>double</TD><TD ALIGN="CENTER">0.0</TD><TD>-MAXFLOAT<BR>-1000</TD><TD></TD> </TR>
 </TABLE>
@@ -821,6 +827,10 @@ This field indicates which graph component uses the attribute.
 <DT><A NAME=d:fontsize HREF=#a:fontsize><STRONG>fontsize</STRONG></A>
 <DD>  Font size, <A HREF=#points>in points</A>, used for text.
 
+<DT><A NAME=d:forcelabels HREF=#a:forcelabels><STRONG>forcelabels</STRONG></A>
+<DD>  If true, all  <A HREF=#d:xlabel><B>xlabel</B></A> attributes are placed, even if there is some overlap with nodes
+  or other labels.
+
 <DT><A NAME=d:group HREF=#a:group><STRONG>group</STRONG></A>
 <DD>  If the end points of an edge belong to the same group, i.e., have the
   same group attribute, parameters are set to avoid crossings and keep
@@ -1796,6 +1806,17 @@ This field indicates which graph component uses the attribute.
   If neither is set explicitly, the minimum of the two default values
   is used.
 
+<DT><A NAME=d:xlabel HREF=#a:xlabel><STRONG>xlabel</STRONG></A>
+<DD>  External label for a node or edge. For nodes, the label will be placed outside of the
+  node but near it. For edges, the label will be placed near the center of the edge.
+  This can be useful in dot to avoid the occasional problem when the use of edge labels
+  distorts the layout. For other layouts, the xlabel attribute can be viewed as a synonym
+  for the <A HREF=#d:label><B>label</B></A> attribute.
+  <P>
+  These labels are added after all nodes and edges have been placed. The labels will be placed
+  so that they do not overlap any node or label. This means it may not be possible to place all
+  of them. To force placing all of them, use the  <A HREF=#d:forcelabels><B>forcelabels</B></A> attribute.
+
 <DT><A NAME=d:z HREF=#a:z><STRONG>z</STRONG></A>
 <DD>  <B>Deprecated:</B>Use <A HREF=#d:pos><B>pos</B></A> attribute, along
   with <A HREF=#d:dimen><B>dimen</B></A> and/or <A HREF=#d:dim><B>dim</B></A>

diff --git a/doc/infosrc/attrs b/doc/infosrc/attrs
index 4cb78af20ca1a97c34187fa32ee6bf97518bf236..5c28bb5cc23a83699c34ef91c931cff189aeccb3 100644 (file)
--- a/doc/infosrc/attrs
+++ b/doc/infosrc/attrs
@@ -342,6 +342,9 @@ If not set, libgd uses its compiled-in font path.
 Note that fontpath is an attribute of the root graph.
 :fontsize:ENGC:double:14.0:1.0;
 Font size, <A HREF=#points>in points</A>, used for text.
+:forcelabels:G:bool:false;
+If true, all  <A HREF=#d:xlabel><B>xlabel</B></A> attributes are placed, even if there is some overlap with nodes
+or other labels.
 :group:N:string:"";  dot
 If the end points of an edge belong to the same group, i.e., have the
 same group attribute, parameters are set to avoid crossings and keep
@@ -1213,6 +1216,16 @@ In this case, if both the width or the height are set explicitly,
 the maximum of the two values is used.
 If neither is set explicitly, the minimum of the two default values
 is used.
+:xlabel:EN:lblString:"";
+External label for a node or edge. For nodes, the label will be placed outside of the
+node but near it. For edges, the label will be placed near the center of the edge.
+This can be useful in dot to avoid the occasional problem when the use of edge labels
+distorts the layout. For other layouts, the xlabel attribute can be viewed as a synonym
+for the <A HREF=#d:label><B>label</B></A> attribute.
+<P>
+These labels are added after all nodes and edges have been placed. The labels will be placed
+so that they do not overlap any node or label. This means it may not be possible to place all
+of them. To force placing all of them, use the  <A HREF=#d:forcelabels><B>forcelabels</B></A> attribute.
 :z:N:double:0.0:-MAXFLOAT/-1000;
 <B>Deprecated:</B>Use <A HREF=#d:pos><B>pos</B></A> attribute, along
 with <A HREF=#d:dimen><B>dimen</B></A> and/or <A HREF=#d:dim><B>dim</B></A>