manuals/getting-started-guide/src/main/asciidoc/bk-getting-started-guide.adoc

   1 [[bk-getting-started-guide]]
   2 = OpenDaylight Getting Started Guide
   3 :docinfo:
   4
   5 //////////////////////////
   6 // BEGIN COMMENT
   7 [dedication]
   8 Example Dedication
   9 ------------------
  10 Optional dedication.
  11
  12 This document is an AsciiDoc book skeleton containing briefly
  13 annotated example elements plus a couple of example index entries and
  14 footnotes.
  15
  16 Books are normally used to generate DocBook markup and the titles of
  17 the preface, appendix, bibliography, glossary and index sections are
  18 significant ('specialsections').
  19
  20
  21 [preface]
  22 Example Preface
  23 ---------------
  24 Optional preface.
  25
  26 Preface Sub-section
  27 ~~~~~~~~~~~~~~~~~~~
  28 Preface sub-section body.
  29
  30 Using OpenDaylight
  31 --------------------------
  32
  33 [partintro]
  34 .Optional part introduction title
  35 --
  36 Optional part introduction goes here.
  37 --
  38
  39 OpenDaylight Add-ons
  40 -------------------------
  41
  42 [partintro]
  43 .Optional part introduction title
  44 --
  45 Optional part introduction goes here.
  46 --
  47 // END COMMENT
  48 //////////////////////////
  49
  50 //////////////////////////
  51 // BEGIN COMMENT
  52 Please note and leave the blank line between include statements here.
  53
  54 It is a defensive measure to prevent individual projects' .adoc files
  55 from eating the next section if they forget to leave a blank line at
  56 the end of their file.
  57 // END COMMENT
  58 //////////////////////////
  59
  60 = Getting to know OpenDaylight
  61
  62 include::chapter_security_considerations.adoc[]
  63
  64 :numbered!:
  65
  66 //////////////////////////
  67 // BEGIN COMMENT
  68 [appendix]
  69 Example Appendix
  70 ----------------
  71 One or more optional appendixes go here at section level 1.
  72
  73 Appendix Sub-section
  74 ~~~~~~~~~~~~~~~~~~~
  75 Sub-section body.
  76
  77
  78 [glossary]
  79 Example Glossary
  80 ----------------
  81 Glossaries are optional. Glossaries entries are an example of a style
  82 of AsciiDoc labeled lists.
  83
  84 [glossary]
  85 A glossary term::
  86   The corresponding (indented) definition.
  87
  88 A second glossary term::
  89   The corresponding (indented) definition.
  90
  91
  92 [colophon]
  93 Example Colophon
  94 ----------------
  95 Text at the end of a book describing facts about its production.
  96
  97
  98 [index]
  99 Example Index
 100 -------------
 101 // END COMMENT
 102 //////////////////////////
 103
 104 ////////////////////////////////////////////////////////////////
 105 The index is normally left completely empty, it's contents being
 106 generated automatically by the DocBook toolchain.
 107 ////////////////////////////////////////////////////////////////