--- /dev/null
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <parent>
+ <groupId>org.opendaylight.documentation</groupId>
+ <artifactId>manuals</artifactId>
+ <version>0.1.0-SNAPSHOT</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>developersguide</artifactId>
+ <packaging>jar</packaging>
+ <name>OpenDaylight Docs - Manuals - Developer's Guide</name>
+ <properties>
+ <!-- This is set by Jenkins according to the branch. -->
+ <release.path.name>local</release.path.name>
+ <comments.enabled>1</comments.enabled>
+ <bookname>bk-developers-guide</bookname>
+ </properties>
+ <!-- ################################################ -->
+ <!-- USE "mvn clean generate-sources" to run this POM -->
+ <!-- ################################################ -->
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoctor-maven-plugin</artifactId>
+ <version>${asciidoctor.version}</version>
+ <executions>
+ <execution>
+ <id>output-docbook</id>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>process-asciidoc</goal>
+ </goals>
+ <configuration>
+ <backend>docbook5</backend>
+ <doctype>book</doctype>
+ </configuration>
+ </execution>
+ </executions>
+ <configuration>
+ <sourceDirectory>src/main/asciidoc</sourceDirectory>
+ <sourceDocumentName>${bookname}.adoc</sourceDocumentName>
+ <imagesDir>./images</imagesDir>
+ </configuration>
+ </plugin>
+ <plugin>
+ <artifactId>maven-resources-plugin</artifactId>
+ <version>2.6</version>
+ <executions>
+ <execution>
+ <id>copy-resources</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${basedir}/target/generated-docs</outputDirectory>
+ <resources>
+ <resource>
+ <directory>src/main/resources</directory>
+ <includes>
+ <include>**/*.*</include>
+ </includes>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
+ <groupId>com.inocybe.api</groupId>
+ <artifactId>sdndocs-maven-plugin</artifactId>
+ <version>0.1.0</version>
+ <executions>
+ <execution>
+ <id>generate-webhelp</id>
+ <goals>
+ <goal>generate-webhelp</goal>
+ </goals>
+ <phase>compile</phase>
+ <configuration>
+ <profileAudience>enduser</profileAudience>
+ <includes>target/generated-docs/${bookname}.xml</includes>
+ <!-- <includes>bk-install-guide.xml</includes> -->
+ <generateToc>
+ appendix toc,title
+ article/appendix nop
+ article toc,title
+ book toc,title,figure,table,example,equation
+ chapter toc,title
+ section toc
+ part toc,title
+ qandadiv toc
+ qandaset toc
+ reference toc,title
+ set toc,title
+ </generateToc>
+ <webhelpDirname>${bookname}</webhelpDirname>
+ <pdfFilenameBase>${bookname}</pdfFilenameBase>
+ </configuration>
+ </execution>
+ </executions>
+ <configuration>
+ <profileAudience>enduser</profileAudience>
+ <chapterAutolabel>1</chapterAutolabel>
+ <sectionAutolabel>0</sectionAutolabel>
+ <tocSectionDepth>1</tocSectionDepth>
+ <formalProcedures>0</formalProcedures>
+ <highlightSource>false</highlightSource>
+ <xincludeSupported>true</xincludeSupported>
+ <showXslMessages>true</showXslMessages>
+ <sourceDirectory>.</sourceDirectory>
+ <feedbackEmail>mlemay@inocybe.com</feedbackEmail>
+ <branding>opendaylight</branding>
+ <coverLogoLeft>2.6in</coverLogoLeft>
+<!-- <enableDisqus>${comments.enabled}</enableDisqus>
+ <disqusShortname>os-user-guide</disqusShortname>
+ <enableGoogleAnalytics>1</enableGoogleAnalytics>
+ <googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
+ --> <suppressFooterNavigation>0</suppressFooterNavigation>
+ <canonicalUrlBase>http://docs.opendaylight.org/user-guide/content/</canonicalUrlBase>
+ <glossaryCollection>${basedir}/../glossary/glossary-terms.xml</glossaryCollection>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+</project>
--- /dev/null
+ <author>
+ <personname>
+ <firstname>Mathieu</firstname>
+ <surname>Lemay</surname>
+ </personname>
+ <email>mlemay@inocybe.com</email>
+ <affiliation>
+ <orgname>Inocybe Technologies</orgname>
+ </affiliation>
+ </author>
+ <copyright>
+ <year>2014</year>
+ <holder>Inocybe Technologies and others.</holder>
+ </copyright>
+ <releaseinfo>master</releaseinfo>
+ <productname>OpenDaylight</productname>
+ <pubdate></pubdate>
+ <legalnotice role="license">
+ <para> This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at <link xlink:href="http://www.eclipse.org/legal/epl-v10.html"/></para>
+ </legalnotice>
+ <abstract>
+ <para>This guide describes how to develop using OpenDaylight.</para>
+ </abstract>
+ <revhistory>
+ <revision>
+ <date>2014-08-03</date>
+ <revdescription>
+ <itemizedlist spacing="compact">
+ <listitem>
+ <para>Initial Guide Creation</para>
+ </listitem>
+ </itemizedlist>
+ </revdescription>
+ </revision>
+ </revhistory>
+
--- /dev/null
+[[bk-user-guide]]
+= OpenDaylight Developer's Guide
+:docinfo:
+
+
+[dedication]
+Example Dedication
+------------------
+Optional dedication.
+
+This document is an AsciiDoc book skeleton containing briefly
+annotated example elements plus a couple of example index entries and
+footnotes.
+
+Books are normally used to generate DocBook markup and the titles of
+the preface, appendix, bibliography, glossary and index sections are
+significant ('specialsections').
+
+
+[preface]
+Example Preface
+---------------
+Optional preface.
+
+Preface Sub-section
+~~~~~~~~~~~~~~~~~~~
+Preface sub-section body.
+
+include::ch-samplech.adoc[]
+
+:numbered!:
+
+[appendix]
+Example Appendix
+----------------
+One or more optional appendixes go here at section level 1.
+
+Appendix Sub-section
+~~~~~~~~~~~~~~~~~~~
+Sub-section body.
+
+
+[glossary]
+Example Glossary
+----------------
+Glossaries are optional. Glossaries entries are an example of a style
+of AsciiDoc labeled lists.
+
+[glossary]
+A glossary term::
+ The corresponding (indented) definition.
+
+A second glossary term::
+ The corresponding (indented) definition.
+
+
+[colophon]
+Example Colophon
+----------------
+Text at the end of a book describing facts about its production.
+
+
+[index]
+Example Index
+-------------
+////////////////////////////////////////////////////////////////
+The index is normally left completely empty, it's contents being
+generated automatically by the DocBook toolchain.
+////////////////////////////////////////////////////////////////
--- /dev/null
+== The First Chapter
+
+Chapters can contain sub-sections nested up to three deep.
+footnote:[An example footnote.]
+indexterm:[Example index entry]
+
+Chapters can have their own bibliography, glossary and index.
+
+And now for something completely different: ((monkeys)), lions and
+tigers (Bengal and Siberian) using the alternative syntax index
+entries.
+(((Big cats,Lions)))
+(((Big cats,Tigers,Bengal Tiger)))
+(((Big cats,Tigers,Siberian Tiger)))
+Note that multi-entry terms generate separate index entries.
+
+Here are a couple of image examples: an image:smallnew.png[]
+example inline image followed by an example block image:
+
+.Tiger block image
+image::tiger.png[Tiger image]
+
+Followed by an example table:
+
+.An example table
+[width="60%",options="header"]
+|==============================================
+| Option | Description
+| -a 'USER GROUP' | Add 'USER' to 'GROUP'.
+| -R 'GROUP' | Disables access to 'GROUP'.
+|==============================================
+
+.An example example
+===============================================
+Lorum ipum...
+===============================================
+
+[[X1]]
+=== Sub-section with Anchor
+
+Sub-section at level 2.
+
+==== Chapter Sub-section
+
+Sub-section at level 3.
+
+===== Chapter Sub-section
+
+Sub-section at level 4.
+
+This is the maximum sub-section depth supported by the distributed
+AsciiDoc configuration.
+footnote:[A second example footnote.]
+
+
+== The Second Chapter
+
+An example link to anchor at start of the <<X1,first sub-section>>.
+indexterm:[Second example index entry]
+
+
+
+== The Third Chapter
+
+Book chapters are at level 1 and can contain sub-sections.
+
Code Review / docs.git / commitdiff
