extra/graphviz/attributes/attributes-docs.factor

   1 ! Copyright (C) 2011 Alex Vondrak.
   2 ! See https://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax strings ;
   4 IN: graphviz.attributes
   5
   6 {
   7     node-attributes
   8     edge-attributes
   9     graph-attributes
  10     <node-attributes>
  11     <edge-attributes>
  12     <graph-attributes>
  13 } related-words
  14
  15 HELP: <edge-attributes>
  16 { $values
  17         { "attrs" edge-attributes }
  18 }
  19 { $description "Constructs " { $instance edge-attributes } " tuple with no attributes set." } ;
  20
  21 HELP: <graph-attributes>
  22 { $values
  23         { "attrs" graph-attributes }
  24 }
  25 { $description "Constructs " { $instance graph-attributes } " tuple with no attributes set." } ;
  26
  27 HELP: <node-attributes>
  28 { $values
  29         { "attrs" node-attributes }
  30 }
  31 { $description "Constructs " { $instance node-attributes } " tuple with no attributes set." } ;
  32
  33 HELP: edge-attributes
  34 { $class-description "Represents Graphviz attributes that are valid for edges. See attributes marked " { $emphasis "E" } " in " { $url "https://graphviz.org/content/attrs" } ". Each slot must be " { $maybe string } "." } ;
  35
  36 HELP: graph-attributes
  37 { $class-description "Represents Graphviz attributes that are valid for graphs and subgraphs (including clusters). See attributes marked " { $emphasis "G" } ", " { $emphasis "S" } ", and " { $emphasis "C" } " in " { $url "https://graphviz.org/content/attrs" } ". Each slot must be " { $maybe string } "." } ;
  38
  39 HELP: node-attributes
  40 { $class-description "Represents Graphviz attributes that are valid for nodes. See attributes marked " { $emphasis "N" } " in " { $url "https://graphviz.org/content/attrs" } ". Each slot must be " { $maybe string } "." } ;
  41
  42 ARTICLE: "graphviz.attributes" "Graphviz attributes"
  43 "In Graphviz, " { $emphasis "attributes" } " control different layout characteristics of graphs, subgraphs, nodes, and edges. For example, you can specify the color of an edge or the shape of a node. Graphviz provides documentation for all valid attributes at " { $url "https://graphviz.org/content/attrs" } "."
  44 $nl
  45 "The " { $vocab-link "graphviz.attributes" } " vocabulary simply provides three different tuples to encapsulate Graphviz attributes:"
  46 { $subsections node-attributes edge-attributes graph-attributes }
  47 "Empty instances are created with the following constructors:"
  48 { $subsections <node-attributes> <edge-attributes> <graph-attributes> }
  49 ;
  50
  51 ABOUT: "graphviz.attributes"