MBW YAML

This page performs a couple of TWiki searches, formatting the results as YAML, for use in assorted post-processing (eg, generation of clickable diagrams).

Format

The generated YAML has the format:

Edges:

  "[name of this edge]":
    Role1:        "[name of Role 1 node]"
    ...
    Summary:      "[executive summary (phrase)]"
    Title:        "[page title]"
    Topic:        "[page topic (TWiki page name)]"
    ViewNames:    "[names of views that include this edge]"
...

Nodes:

  "[name of this node]":
    Summary:      "[executive summary (phrase)]"
    Title:        "[page title]"
    Topic:        "[page topic (TWiki page name)]"
    ViewNames:    "[names of views that include this edge]"
...

Views:

  "[name of this view]":
    Summary:      "[executive summary (phrase)]"
    Title:        "[page title]"
    Topic:        "[page topic (TWiki page name)]"
    NodeOmits:    "[nodes to omit from diagram]"
    DotOptions:   "[options for dot(1) program]"
...

Data

# .../Projects/MBW/MBW_d_Mbw.yml
#
# This is machine-generated YAML (http://www.yaml.org) code; do NOT edit!
# See http://wiki.cfcl.com/bin/view/Projects/MBW/MBW_d/MbwYAML for more information.

Edges:

  "Node -> MBW Includes":
    Role1:        "Node"
    Role2:        "MBW Includes"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'MBW Includes' by Node"
    Title:        "Node -> MBW Includes"
    Topic:        "E_e__m_incl"
    ViewNames:    "Infrastructure, Node Page Gen."

  "Edge -> MBW YAML":
    Role1:        "Edge"
    Role2:        "MBW YAML"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'Edge' data by 'MBW YAML'"
    Title:        "Edge -> MBW YAML"
    Topic:        "E_e__m_yaml"
    ViewNames:    "Diagram Gen."

  "Edge Create -> Edge":
    Role1:        "Edge Create"
    Role2:        "Edge"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "creation of 'Edge' by 'Edge Create'"
    Title:        "Edge Create -> Edge"
    Topic:        "E_e_create__e"
    ViewNames:    "Edge Creation, Infrastructure"

  "Edge Form -> Edge":
    Role1:        "Edge Form"
    Role2:        "Edge"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'Edge Form' by 'Edge'"
    Title:        "Edge Form -> Edge"
    Topic:        "E_e_form__e"
    ViewNames:    "Edge Creation, Infrastructure"

  "Edge Template -> Edge":
    Role1:        "Edge Template"
    Role2:        "Edge"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'Edge Template' as basis for an 'Edge'"
    Title:        "Edge Template -> Edge"
    Topic:        "E_e_tmpl__e"
    ViewNames:    "Edge Creation, Infrastructure"

  "mbw2dot script -> MBW Images":
    Role1:        "mbw2dot"
    Role2:        "MBW Images"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "generation of 'MBW Images' by mbw2dot script"
    Title:        "mbw2dot script -> MBW Images"
    Topic:        "E_m2d__m_imgs"
    ViewNames:    "Diagram Gen."

  "MBW Admin -> MBW Intro":
    Role1:        "MBW Admin"
    Role2:        "MBW Intro"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "link from 'MBW Admin' to 'MBW Intro'"
    Title:        "MBW Admin -> MBW Intro"
    Topic:        "E_m_admin__m_intr"
    ViewNames:    "Documentation"

  "MBW Admin -> MBW Todo List":
    Role1:        "MBW Admin"
    Role2:        "MBW Todo List"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "link from 'MBW Admin' to 'MBW Todo List'"
    Title:        "MBW Admin -> MBW Todo List"
    Topic:        "E_m_admin__m_todo"
    ViewNames:    "Documentation, Infrastructure"

  "MBW Includes -> Edge Index":
    Role1:        "MBW Includes"
    Role2:        "Edge Index"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'MBW Includes' by 'Edge Index'"
    Title:        "MBW Includes -> Edge Index"
    Topic:        "E_m_incl__e_indx"
    ViewNames:    "Edge Index Gen., Infrastructure"

  "MBW Includes -> MBW Includes AB":
    Role1:        "MBW Includes"
    Role2:        "MBW Includes AB"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'MBW Includes AB' by 'MBW Includes'"
    Title:        "MBW Includes -> MBW Includes AB"
    Topic:        "E_m_incl__m_incl_ab"
    ViewNames:    "Edge Page Gen., Infrastructure, Node Page Gen., View Page Gen."

  "MBW Includes -> MBW Includes AW":
    Role1:        "MBW Includes"
    Role2:        "MBW Includes AW"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'MBW Includes AW' by 'MBW Includes'"
    Title:        "MBW Includes -> MBW Includes AW"
    Topic:        "E_m_incl__m_incl_aw"
    ViewNames:    "Edge Index Gen., Infrastructure, Node Index Gen., View Index Gen."

  "MBW Includes -> Node Index":
    Role1:        "MBW Includes"
    Role2:        "Node Index"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'MBW Includes' by 'Node Index'"
    Title:        "MBW Includes -> Node Index"
    Topic:        "E_m_incl__n_indx"
    ViewNames:    "Infrastructure, Node Index Gen."

  "MBW Includes -> View Index":
    Role1:        "MBW Includes"
    Role2:        "View Index"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'MBW Includes' by 'View Index'"
    Title:        "MBW Includes -> View Index"
    Topic:        "E_m_incl__v_indx"
    ViewNames:    "Infrastructure, View Index Gen."

  "MBW YAML -> mbw2dot script":
    Role1:        "MBW YAML"
    Role2:        "mbw2dot"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'MBW YAML' by mbw2dot script"
    Title:        "MBW YAML -> mbw2dot script"
    Topic:        "E_m_yaml__m2d"
    ViewNames:    "Diagram Gen."

  "Node -> MBW Includes":
    Role1:        "Node"
    Role2:        "MBW Includes"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'MBW Includes' by a Node"
    Title:        "Node -> MBW Includes"
    Topic:        "E_n__m_incl"
    ViewNames:    "Infrastructure, Node Page Gen."

  "Node -> MBW YAML":
    Role1:        "Node"
    Role2:        "MBW YAML"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'Node' data by 'MBW YAML'"
    Title:        "Node -> MBW YAML"
    Topic:        "E_n__m_yaml"
    ViewNames:    "Diagram Gen."

  "Node Create -> Node":
    Role1:        "Node Create"
    Role2:        "Node"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "creation of 'Node' by 'Node Create'"
    Title:        "Node Create -> Node"
    Topic:        "E_n_create__n"
    ViewNames:    "Infrastructure, Node Creation"

  "Node Form -> Node":
    Role1:        "Node Form"
    Role2:        "Node"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'Node Form' by 'Node'"
    Title:        "Node Form -> Node"
    Topic:        "E_n_form__n"
    ViewNames:    "Infrastructure, Node Creation"

  "Node Name -> Node Names":
    Role1:        "Node Name"
    Role2:        "Node Names"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'Node Names' by 'Node Name'"
    Title:        "Node Name -> Node Names"
    Topic:        "E_n_name__n_names"
    ViewNames:    "Infrastructure, Node Page Gen."

  "Node Omits -> Node Names":
    Role1:        "Node Omits"
    Role2:        "Node Names"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'Node Names' by 'Node Omits'"
    Title:        "Node Omits -> Node Names"
    Topic:        "E_n_omits__n_names"
    ViewNames:    "Infrastructure, View Page Gen."

  "Node Omits -> View":
    Role1:        "Node Omits"
    Role2:        "View"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'Node Omits' by 'View'"
    Title:        "Node Omits -> View"
    Topic:        "E_n_omits__v"
    ViewNames:    "Infrastructure, View Creation"

  "Node Template -> Node":
    Role1:        "Node Template"
    Role2:        "Node"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'Node Template' as basis for a 'Node'"
    Title:        "Node Template -> Node"
    Topic:        "E_n_tmpl__n"
    ViewNames:    "Infrastructure, Node Creation"

  "Role N -> Node Names":
    Role1:        "Role N"
    Role2:        "Node Names"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'Node Names' by 'Role N'"
    Title:        "Role N -> Node Names"
    Topic:        "E_r_names__n_names"
    ViewNames:    "Edge Page Gen., Infrastructure"

  "Role N -> Edge":
    Role1:        "Role N"
    Role2:        "Edge"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'Role N' by 'Edge'"
    Title:        "Role N -> Edge"
    Topic:        "E_rn__e"
    ViewNames:    "Edge Creation, Infrastructure"

  "View -> MBW Includes":
    Role1:        "View"
    Role2:        "MBW Includes"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'MBW Includes' by View"
    Title:        "View -> MBW Includes"
    Topic:        "E_v__m_incl"
    ViewNames:    "Infrastructure, View Page Gen."

  "View -> MBW YAML":
    Role1:        "View"
    Role2:        "MBW YAML"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'View' data by 'MBW YAML'"
    Title:        "View -> MBW YAML"
    Topic:        "E_v__m_yaml"
    ViewNames:    "Diagram Gen."

  "View Create -> View":
    Role1:        "View Create"
    Role2:        "View"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "creation of 'View' by 'View Create'"
    Title:        "View Create -> View"
    Topic:        "E_v_create__v"
    ViewNames:    "Infrastructure, View Creation"

  "View Form -> View":
    Role1:        "View Form"
    Role2:        "View"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'View Form' by 'View'"
    Title:        "View Form -> View"
    Topic:        "E_v_form__v"
    ViewNames:    "Infrastructure, View Creation"

  "View Name -> View":
    Role1:        "View Name"
    Role2:        "View"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'View Name' by 'View'"
    Title:        "View Name -> View"
    Topic:        "E_v_name__v"
    ViewNames:    "Infrastructure, View Creation"

  "View Name -> View Names":
    Role1:        "View Name"
    Role2:        "View Names"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "inclusion of 'View Names' by 'View Name'"
    Title:        "View Name -> View Names"
    Topic:        "E_v_name__v_names"
    ViewNames:    "Infrastructure, View Page Gen."

  "View Template -> View":
    Role1:        "View Template"
    Role2:        "View"
    Role3:        "Unspecified"
    Role4:        "Unspecified"
    Role5:        "Unspecified"
    Summary:      "use of 'View Template' as basis for 'View'"
    Title:        "View Template -> View"
    Topic:        "E_v_tmpl__v"
    ViewNames:    "Infrastructure, View Creation"

Nodes:

  "Edge":
    Summary:      "E_*.txt"
    Title:        "An 'Edge' Page"
    Topic:        "N_e"
    ViewNames:    "Diagram Gen., Edge Creation, Edge Index Gen., Edge Page Gen."

  "Edge Create":
    Summary:      "EdgeCreate.txt"
    Title:        "The 'Edge Create' Page"
    Topic:        "N_e_create"
    ViewNames:    "Edge Creation"

  "Edge Form":
    Summary:      "EdgeForm.txt"
    Title:        "The 'Edge Form' Page"
    Topic:        "N_e_form"
    ViewNames:    "Edge Creation, Edge Page Gen."

  "Edge Index":
    Summary:      "EdgeIndex.txt"
    Title:        "The 'Edge Index' Page"
    Topic:        "N_e_index"
    ViewNames:    "Documentation, Edge Index Gen."

  "Edge Template":
    Summary:      "EdgeTemplate.txt"
    Title:        "The 'Edge Template' Page"
    Topic:        "N_e_tmpl"
    ViewNames:    "Edge Creation"

  "MBW":
    Summary:      "MBW page"
    Title:        "MBW"
    Topic:        "N_m"
    ViewNames:    "Unspecified"

  "MBW Admin":
    Summary:      "MbwAdmin.txt"
    Title:        "The 'MBW Admin' Page"
    Topic:        "N_m_admin"
    ViewNames:    "Documentation, Infrastructure"

  "MBW Images":
    Summary:      "MbwImages.txt"
    Title:        "The 'MBW Images' Page"
    Topic:        "N_m_imgs"
    ViewNames:    "Diagram Gen., Documentation, Infrastructure"

  "MBW Includes":
    Summary:      "MbwIncludes.txt"
    Title:        "The 'MBW Includes' Page"
    Topic:        "N_m_incl"
    ViewNames:    "Documentation, Edge Page Gen., Infrastructure, Node Page Gen., View Page Gen."

  "MBW Includes AB":
    Summary:      "MbwIncludesAB.txt"
    Title:        "The 'MBW Includes AB' Page"
    Topic:        "N_m_incl_ab"
    ViewNames:    "Edge Page Gen., Infrastructure, Node Page Gen., View Page Gen."

  "MBW Includes AW":
    Summary:      "MbwIncludesAW.txt"
    Title:        "The 'MBW Includes AW' Page"
    Topic:        "N_m_incl_aw"
    ViewNames:    "Edge Index Gen., Infrastructure, Node Index Gen., View Index Gen."

  "MBW Intro":
    Summary:      "MbwIntro.txt"
    Title:        "The 'MBW Intro' Page"
    Topic:        "N_m_intr"
    ViewNames:    "Documentation"

  "MBW Todo List":
    Summary:      "MbwTodoList.txt"
    Title:        "The 'MBW Todo List' Page"
    Topic:        "N_m_todo"
    ViewNames:    "Documentation"

  "MBW YAML":
    Summary:      "MbwYAML.txt"
    Title:        "The 'MBW YAML' Page"
    Topic:        "N_m_yaml"
    ViewNames:    "Diagram Gen., Infrastructure"

  "Node":
    Summary:      "N_*.txt"
    Title:        "A 'Node' Page"
    Topic:        "N_n"
    ViewNames:    "Diagram Gen., Node Creation, Node Index Gen., Node Page Gen."

  "Node Create":
    Summary:      "NodeCreate.txt"
    Title:        "The 'Node Create' Page"
    Topic:        "N_n_create"
    ViewNames:    "Infrastructure, Node Creation"

  "Node Form":
    Summary:      "NodeForm.txt"
    Title:        "The 'Node Form' Page"
    Topic:        "N_n_form"
    ViewNames:    "Infrastructure, Node Creation, Node Page Gen."

  "Node Index":
    Summary:      "NodeIndex.txt"
    Title:        "The 'Node Index' Page"
    Topic:        "N_n_index"
    ViewNames:    "Documentation, Infrastructure, Node Index Gen."

  "Node Name":
    Summary:      "NodeName.txt"
    Title:        "The 'Node Name' Page"
    Topic:        "N_n_name"
    ViewNames:    "Infrastructure, Node Creation"

  "Node Names":
    Summary:      "NodeNames.txt"
    Title:        "The 'Node Names' Page"
    Topic:        "N_n_names"
    ViewNames:    "Node Index Gen."

  "Node Omits":
    Summary:      "NodeOmits.txt"
    Title:        "The 'Node Omits' Page"
    Topic:        "N_n_omits"
    ViewNames:    "Diagram Gen., View Creation"

  "Node Template":
    Summary:      "NodeTemplate.txt"
    Title:        "The 'Node Template' Page"
    Topic:        "N_n_tmpl"
    ViewNames:    "Infrastructure, Node Creation"

  "Role N":
    Summary:      "Role[1-5].txt"
    Title:        "The 'Role N' Page"
    Topic:        "N_rn"
    ViewNames:    "Edge Creation, Edge Page Gen., Infrastructure"

  "Topic Tree":
    Summary:      "TopicTree.txt"
    Title:        "The 'Topic Tree' Page"
    Topic:        "N_topic"
    ViewNames:    "Infrastructure, Topic Tree Gen."

  "View":
    Summary:      "V_*.txt"
    Title:        "A 'View' Page"
    Topic:        "N_v"
    ViewNames:    "Diagram Gen., View Creation, View Index Gen., View Page Gen."

  "View Create":
    Summary:      "ViewCreate.txt"
    Title:        "The 'View Create' Page"
    Topic:        "N_v_create"
    ViewNames:    "Infrastructure, View Creation"

  "View Form":
    Summary:      "ViewForm.txt"
    Title:        "The 'View Form' Page"
    Topic:        "N_v_form"
    ViewNames:    "Infrastructure, View Creation, View Page Gen."

  "View Index":
    Summary:      "ViewIndex.txt"
    Title:        "The 'View Index' Page"
    Topic:        "N_v_index"
    ViewNames:    "Documentation, Infrastructure, View Index Gen."

  "View Name":
    Summary:      "ViewNames.txt"
    Title:        "The 'View Name' Page"
    Topic:        "N_v_name"
    ViewNames:    "Infrastructure, View Creation, View Index Gen."

  "View Names":
    Summary:      "ViewNames.txt"
    Title:        "The 'View Names' Page"
    Topic:        "N_v_names"
    ViewNames:    "Node Creation, View Index Gen."

  "View Template":
    Summary:      "ViewTemplate.txt"
    Title:        "The 'View Template' Page"
    Topic:        "N_v_tmpl"
    ViewNames:    "Infrastructure, View Creation"

  "mbw2dot":
    Summary:      "mbw2dot script"
    Title:        "mbw2dot script"
    Topic:        "N_m2d"
    ViewNames:    "Diagram Gen."

Views:

  "Diagram Gen.":
    Summary:      "generation of context diagrams"
    Title:        "Diagram Generation"
    Topic:        "V_diag_gen"
    NodeOmits:    "Unspecified, Node Omits"
    DotOptions:   ""

  "Documentation":
    Summary:      "MBW Documentation"
    Title:        "Documentation"
    Topic:        "V_doc"
    NodeOmits:    "Edge Index, MBW Images, MBW Includes, Node Index, View Index"
    DotOptions:   ""

  "Edge Creation":
    Summary:      "Edge Creation"
    Title:        "Edge Creation"
    Topic:        "V_ec"
    NodeOmits:    ""
    DotOptions:   "rankdir=TB"

  "Edge Index Gen.":
    Summary:      "Edge Index Generation"
    Title:        "Edge Index Generation"
    Topic:        "V_ei_gen"
    NodeOmits:    ""
    DotOptions:   ""

  "Edge Page Gen.":
    Summary:      "Edge Page Generation"
    Title:        "Edge Page Generation"
    Topic:        "V_ep_gen"
    NodeOmits:    ""
    DotOptions:   ""

  "Infrastructure":
    Summary:      "Infrastructure"
    Title:        "Infrastructure"
    Topic:        "V_is"
    NodeOmits:    ""
    DotOptions:   ""

  "Node Creation":
    Summary:      "Node Creation"
    Title:        "Node Creation"
    Topic:        "V_nc"
    NodeOmits:    ""
    DotOptions:   "rankdir=TB"

  "Node Index Gen.":
    Summary:      "Node Index Generation"
    Title:        "Node Index Generation"
    Topic:        "V_ni_gen"
    NodeOmits:    ""
    DotOptions:   ""

  "Node Page Gen.":
    Summary:      "Node Page Generation"
    Title:        "Node Page Generation"
    Topic:        "V_np_gen"
    NodeOmits:    ""
    DotOptions:   ""

  "Topic Tree Gen.":
    Summary:      "Topic Tree Generation"
    Title:        "Topic Tree Generation"
    Topic:        "V_tt_gen"
    NodeOmits:    ""
    DotOptions:   ""

  "View Creation":
    Summary:      "View Creation"
    Title:        "View Creation"
    Topic:        "V_vc"
    NodeOmits:    ""
    DotOptions:   "rankdir=TB"

  "View Index Gen.":
    Summary:      "View Index Generation"
    Title:        "View Index Generation"
    Topic:        "V_vi_gen"
    NodeOmits:    ""
    DotOptions:   ""

  "View Page Gen.":
    Summary:      "View Page Generation"
    Title:        "View Page Generation"
    Topic:        "V_vp_gen"
    NodeOmits:    ""
    DotOptions:   ""


This wiki page is maintained by Rich Morin, an independent consultant specializing in software design, development, and documentation. Please feel free to email comments, inquiries, suggestions, etc!

Topic revision: r8 - 08 Sep 2008, RichMorin

Available Webs


This site is powered by Foswiki Copyright © by the contributing authors. All material on this wiki is the property of the contributing authors.
Foswiki version v2.1.6, Release Foswiki-2.1.6, Plugin API version 2.4
Ideas, requests, problems regarding CFCL Wiki? Send us email