manuals/user-guide/src/main/asciidoc/bk-user-guide.adoc

   1 [[bk-user-guide]]
   2 = OpenDaylight User Guide
   3 :docinfo:
   4
   5
   6 [dedication]
   7 Example Dedication
   8 ------------------
   9 Optional dedication.
  10
  11 This document is an AsciiDoc book skeleton containing briefly
  12 annotated example elements plus a couple of example index entries and
  13 footnotes.
  14
  15 Books are normally used to generate DocBook markup and the titles of
  16 the preface, appendix, bibliography, glossary and index sections are
  17 significant ('specialsections').
  18
  19
  20 [preface]
  21 Example Preface
  22 ---------------
  23 Optional preface.
  24
  25 Preface Sub-section
  26 ~~~~~~~~~~~~~~~~~~~
  27 Preface sub-section body.
  28
  29 include::addons/aaa.adoc[]
  30 include::addons/bgpcep.adoc[]
  31 include::addons/defense4all.adoc[]
  32 include::addons/groupbasedpolicy.adoc[]
  33 include::addons/l2switch.adoc[]
  34 include::addons/lispflow.adoc[]
  35 include::addons/ovsdb.adoc[]
  36 include::addons/pcmm.adoc[]
  37 include::addons/plugin2oc.adoc[]
  38 include::addons/sfc.adoc[]
  39 include::addons/snbi.adoc[]
  40 include::addons/snmp4sdn.adoc[]
  41 include::addons/vtn.adoc[]
  42 include::addons/yangtools.adoc[]
  43
  44 :numbered!:
  45
  46 [appendix]
  47 Example Appendix
  48 ----------------
  49 One or more optional appendixes go here at section level 1.
  50
  51 Appendix Sub-section
  52 ~~~~~~~~~~~~~~~~~~~
  53 Sub-section body.
  54
  55
  56 [glossary]
  57 Example Glossary
  58 ----------------
  59 Glossaries are optional. Glossaries entries are an example of a style
  60 of AsciiDoc labeled lists.
  61
  62 [glossary]
  63 A glossary term::
  64   The corresponding (indented) definition.
  65
  66 A second glossary term::
  67   The corresponding (indented) definition.
  68
  69
  70 [colophon]
  71 Example Colophon
  72 ----------------
  73 Text at the end of a book describing facts about its production.
  74
  75
  76 [index]
  77 Example Index
  78 -------------
  79 ////////////////////////////////////////////////////////////////
  80 The index is normally left completely empty, it's contents being
  81 generated automatically by the DocBook toolchain.
  82 ////////////////////////////////////////////////////////////////
  83