From bca2335aa341836f1c102a8ba7e3bcf90755590c Mon Sep 17 00:00:00 2001
From: Eric Lippmann <eric.lippmann@netways.de>
Date: Tue, 9 Dec 2014 14:58:18 +0100
Subject: [PATCH] doc: Add module documentation

---
 modules/doc/doc/1-module-documentation.md |  59 ++++++++++++++++++++++
 modules/doc/public/img/doc/markdown.png   | Bin 0 -> 2180 bytes
 2 files changed, 59 insertions(+)
 create mode 100644 modules/doc/doc/1-module-documentation.md
 create mode 100644 modules/doc/public/img/doc/markdown.png

diff --git a/modules/doc/doc/1-module-documentation.md b/modules/doc/doc/1-module-documentation.md
new file mode 100644
index 000000000..968dd32d7
--- /dev/null
+++ b/modules/doc/doc/1-module-documentation.md
@@ -0,0 +1,59 @@
+# <a id="module-documentation"></a> Writing Module Documentation
+
+![Markdown](/img/doc/doc/markdown.png)
+
+Icinga Web 2 is capable of viewing your module's documentation, if the documentation is written in
+[Markdown](http://en.wikipedia.org/wiki/Markdown). Please refer to
+[Markdown Syntax Documentation](http://daringfireball.net/projects/markdown/syntax) for Markdown's formatting syntax.
+
+## <a id="location"></a> Where to Put Module Documentation?
+
+By default, your module's Markdown documentation files must be placed in the `doc` directory beneath your module's root
+directory, e.g.:
+
+    example-module/doc
+
+## <a id="chapters"></a> Chapters
+
+Each Markdown documentation file represents a chapter of your module's documentation. The first found heading inside
+each file is the chapter's title. The order of chapters is based on the case insensitive "Natural Order" of your files'
+names. <dfn>Natural Order</dfn> means that the file names are ordered in the way which seems natural to humans.
+It is best practice to prefix Markdown documentation file names with numbers to ensure that they appear in the correct
+order, e.g.:
+
+    1-about.md
+    2-installation.md
+    3-configuration.md
+
+## <a id="toc"></a> Table Of Contents
+
+The table of contents for your module's documentation is auto-generated based on all found headings inside each
+Markdown documentation file.
+
+## <a id="linking"></a> Linking Between Headings
+
+For linking between headings, place an anchor where you want to link to, e.g.:
+
+    # <a id="heading"></a> Heading
+
+Now you can reference the anchor either in the same or **in another** Markdown documentation file, e.g.:
+
+    This is a link to [Heading](#heading).
+
+## <a id="images"></a> Including Images
+
+Images must placed in the `img` directory beneath your module's `public` directory, e.g.:
+
+    example-module/public/img/doc
+
+Module images can be accessed using the following URL:
+
+    {baseURL}/img/{moduleName}/{file} e.g. icingaweb/img/example-module/doc/example.png
+
+Markdown's image syntax is very similar to Markdown's link syntax, but prefixed with an exclamation mark, e.g.:
+
+    ![Alt text](http://path/to/img.png "Optional Title")
+
+URLs to images inside your Markdown documentation files must be specified without the base URL, e.g.:
+
+    ![Example](/img/example-module/doc/example.png)
diff --git a/modules/doc/public/img/doc/markdown.png b/modules/doc/public/img/doc/markdown.png
new file mode 100644
index 0000000000000000000000000000000000000000..93e729bc77ca37a36b97509e4cd552e1033973f9
GIT binary patch
literal 2180
zcmaJ@3pCSxAD^wcY}Rs*WtD5G;fWbxQ?n;Z>?w^%R6I%eyW|avwnDTzlpgZBtwM^W
z$&fc$p0XlZVkGpJ%9=})+uYyj>FGV^J@0wX@BDth^Z8yr-|z2ozQ11@)qNKVp@)D#
zAShQC=Y8^7DDMnqMfn(SHgsM-DIVRk%Neq~(%AL4Ga(RVJ6Go&p0RnOeIBWSURr{2
zV9NH=6SaIdWsU6zYpF*>w^r?SPJ8+5^CpE~4C*p6D4tIbHc`%DUNAB?veYywr;e#^
zaz?4Cq&-PC+*Haou<j=Bj>xvm2{sx1AYzT)DwFiqExY&4%=43HC+dds?#|>&h%xi^
zx;6p^oiWdh=I8VE`M9QZo$(Po7!<HxhLi3Gjls`#=seEs{As8TQ;BJH0)H{|4?8Ii
zRF^iJ6oPM99#QOK`~Y5wNJ$z@`p7dsw5R3G9C6o~mTgPw;m0FE*dUCOv|i)z<^H*T
zakrQOK+v7#E`h8(<3|Wb!orgQFE)~&9^z$GnM_o1KrJJMt{@QHZgMmd6}vtn;rO_c
zKV?9T+XH_L9nccn4xozO`O=IkgFf^9ATw%&wt3wMZ0zZ&tCVJ2itX*QI}T|R5z^LF
zw9F?z(fOZonsltW!lPgZS<c11sa1gq#_`yISFzHBDT&Sri9@y9f<Bls4!*(LuQ?&M
z3C*b``YtpcHT~dyCCmoaU$w6G!BR%eCWmcWpQ9a3oD8<zgrpf!8P4jPoD5VnH(XhT
z$Z&zeU5uDeqpMB|>aOhnQsZFP=G)5(%X|~By~=Fx_lO@0<IwhgN)#@mdVSe#o-^tp
z!?Q-iTtYObewCOJk)GWL<%Nf2Q}?GGcKpJvaa9yUWT=RnPW4>(H6fcjZ<{(!+q{M7
zL%a|jm|;W^eX>Z<Z=%nJHTq5Y#6?j29P<OuW9hkP7(OVi-6)hp!4J5)l;pX|&RQCK
z6%{|SSHY*;hn(C_hNYXnWefT>+2pb&>WxVuf6&!N%q75st9Gx}3Q_&xzMt`HSqJro
z=%-qo`Uky~8XXLd8(}89bD>p%pY+T+uzIl$FBBc8OCTI?yA%ZPf+E(Vaz}doW~Y<1
zX6lV+Kiz{{drp-KLw>pkdUMIiS$`+v#&ciXRrd<waRg(Q=e>?z5=^O#DOo^RZ*8I8
zn39t$x64;()pZw=%nK<6kNl+3e3*sOdh~bFR-Jm$nF9xz(E1$M5aT54{a2{h_-um5
z*pMM*Y^a?KloXT@o!8nscnXD1qV_Gq*X9~?3AHgBx5Uc)<1OEMZGZ>U<7{6jW}-44
zCu#gV*-1_ISDtx5^4Dr}r{*u8E_V#_k#Hg)i9hn2Z#rPJI({T93Mgt*{`&UNvsduX
z6>9z0^WO{=g$R!UnR$(^OeBApgWT8=!K7xMD$lkUSUqunHu{krPhb%(-@D)M@dS_^
z@79xSB?80v@7rlJ3*qURsglq4EH>5lf{`b91>MqLwvo{Ig8SE?`z7|U5gl1g7AGMK
zAaY(;bgIhSlLfb?=4^7&MlWBHFPm;H=6B4EDTZsxW}1eZKD-a<tLTgbbD%MC2R&c{
zb?o|y3F@%QyDI*=sm`@#<^OV{wI*`H6%zf})uQ2N6kxNQrPVYv6B^y=6;&GWuw>_G
zBF7ze){N?3Hl+mm>0)){4D%{1oTXPnaSEa(MUgXqnTs6JD&<c17{1RHBZO*EXf2xj
zI!<B+w@NFZF(RMkRsFf+<5Wi0bG)ZF!CKl5TtY)Dv`cxD@j<`Q-4Q~B{0?!uMExlc
zg)`7XuZ=#{hn0wj!AL4Y<f3a98g=@DXt7DA8u7rX^<mdukhwFR39V`>A;X7-0p&3b
zTyyPGyO}!gaytCE(LYMpSXr-~5CY`_WJmr<$HVsl1IhJM3_j5_RbTH?+!sPh7ml>q
z_f)wiTRH2-PKn=R$0^L8@3IOzaNB7JYS965^17O&NfDrG;hPv0`kK3sVSvM!g>IL#
zihy#FTo|?@w6VmR6{(_{9Hud4omqvB691u{3OzzgPnVT2qXgP0j`Xlb?7i7Z<*~~W
zvV}fIpmA^{<LVVro1Fg(j#T^ubOU$fn(xMKlRZG%e?TwLCO7+`=>_iLNcbN<{eUE^
z&}U^G8;+L<zn1tWhJ>%=m6x--fhz~VUtnK@2uGsJ9%{8-hkkt7G3QtF>2{~K{ucQ2
zoI6v<mYRjC-kZmYA$C^0M5RF-iSt(|H_rP%Q*b1#JXTJ@g&O=8kCKl{e7dq}9~#qj
z^*~FmDl7K)W(q*i)xNX)e-y+2Q!9@`i~71(ifqCKsm3|&ns6HHxyUZeVT`9A5bhxB
zO?j3Ynu}hWPS+jLX{6iGa}1VVGKTI4eVEk;?~ZE}Dq&yvaZ(Mfz~OF-_;2>wN`gZ#
zKMW;V<~MuSy6m~FJT&>>Y0$tit47L`8RomPY+Pl%{Qa=!pJkY0bPOxQ%wd4)#8@WZ
zpK0IIX;_J$X3oI6E)e$l!yk9t!(QQh3j((<ETb+jxy2gKQCSzAtDhQ!X#<2o`*VvI
zBMvM+z;981tL~wIjuhWy4MOzSg!4{AWtKh5CeV#K=?Z8VfL&tU8gq?<EU3$nQZ-P&
zxJ)B5boCjgai-(|A!gAq0v>zbGSW7u-de3;TBTxpAw02RWW#WF@b|}A1v5Hkbm`Ii
v0@|%qBtaQNUf$8&Gpzv{H;#JK<}AKdSfrDxI5YBZ1;mx&?tE`&z`1_|&HV@>

literal 0
HcmV?d00001