From 5f361d913b2a7932b6df618c9e1f6ee3a67cb1b6 Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Sat, 5 Oct 2019 22:03:10 +0200 Subject: [PATCH] Add help module doc --- Docs/Help/en/SUMMARY.md | 3 +++ Docs/Help/en/documentation.md | 17 +++++++++++++++++ Docs/Help/en/introduction.md | 11 +++++++++++ Docs/Help/img/directory_structure.png | Bin 0 -> 9385 bytes Docs/introduction.md | 21 --------------------- 5 files changed, 31 insertions(+), 21 deletions(-) create mode 100644 Docs/Help/en/SUMMARY.md create mode 100644 Docs/Help/en/documentation.md create mode 100644 Docs/Help/en/introduction.md create mode 100644 Docs/Help/img/directory_structure.png delete mode 100644 Docs/introduction.md diff --git a/Docs/Help/en/SUMMARY.md b/Docs/Help/en/SUMMARY.md new file mode 100644 index 0000000..1aa7e99 --- /dev/null +++ b/Docs/Help/en/SUMMARY.md @@ -0,0 +1,3 @@ +# Table of Contents + +* [Documentation]({%}&page=documentation) \ No newline at end of file diff --git a/Docs/Help/en/documentation.md b/Docs/Help/en/documentation.md new file mode 100644 index 0000000..1368154 --- /dev/null +++ b/Docs/Help/en/documentation.md @@ -0,0 +1,17 @@ +# Documentation + +A documentation can be added to every module by adding the `Docs/Help/{lang}` directory in the module. The language directory needs to be a 2 character ISO code. Inside of this directory you can add/find all the documentation files provided by the module. + +Mandatory files are a `SUMMARY.md` file which contains the list of all documents and a `introduction.md` file which contains a general description of the module. + +## SUMMARY.md example + +```md +# Table of Contents + +* [Link Name 1]({%}&page=document_name_1) +* [Link Name 2]({%}&page=document_name_2) +* [Link Name 3]({%}&page=document_name_3) +``` + +![Directory Structure](Modules/Help/Docs/Help/img/directory_structure.png) \ No newline at end of file diff --git a/Docs/Help/en/introduction.md b/Docs/Help/en/introduction.md new file mode 100644 index 0000000..e23d9b5 --- /dev/null +++ b/Docs/Help/en/introduction.md @@ -0,0 +1,11 @@ +# Introduction + +The **Help** module is one of the essential core modules that is always required. This module allows other modules to provide helpful documentation for users, administrators and developers. + +## Target Group + +The target group for this module is everyone. + +# Setup + +This module doesn't have any additional setup requirements since it is installed during the application install process. This module cannot be uninstalled if it is manually deleted from the hard drive please manually download the module from the page and put it into the `Modules/` directory. \ No newline at end of file diff --git a/Docs/Help/img/directory_structure.png b/Docs/Help/img/directory_structure.png new file mode 100644 index 0000000000000000000000000000000000000000..dbcda3e155fac6148d47bdc1e85711ca2b0a5f80 GIT binary patch literal 9385 zcmaiaWmp_tw`HNhLlOuUf+Yk9?hXNhySoQz+$~rLE(yWi(zrD4E{!L+ySp~tF#Ue_ z&YhV%-#qi9y81^|J$24rd#|O97z5iQ8WNR3CKu%QujCLsKbkIl{4GaD!P zdia$BhnJ~bu1u7JyawZ$7pJf_v2W%FkbEv1cTWrfn!2cWoVUkfC(Q5q(P>*^lP&~p zbaKlM<jmR#16#Pq+w)_8@zHSKBU8M z?FD_`65wKYbviVb3fyH1qAjIwPV}Pvp6t3V&< z#=I8TW7^SN&4E{y1BZc;UiQO-b4NXm_O1So&8{-r{zWDk7XH zWB!*vAT_#np#4#|gXv$=zoVjX0BJ=DOt@l-&xOtT>Wc(K6=1>ohK zy}!Bnoqs&J=em@x>MmGtt66KEcC^L1A58*?=Euo!p7+n>lSZo{0o~cHntv6j#zVM6 z;uQRAk;jZK)Bg1^hn2RCC65&qIsyTY<9$O7AUlz6i^+6?JNPq?os~H#LpAQY!gcv* zepy}C1ELa6;7<)gWxgyx+zeK=n>%02V*LH6YrVU!U8b718d>xvs}h5Lvw7@HuF4(<}ShSwPw5H3AA+emTipXgDRiAM%v-@^2Iu- zpNl|N z&KP8q*g*Wmva+K)*g>H>$e*x(&GG7F1-jr8mqvE7O0U|EQ>!Xld_TW>9vMk+Ega;8jAj`rI2G*_8! zB40s`j)23G7Jge?VbH9psd=?C^yxA@FztuidXG%BWV8E`9wGwcpxUL)sL03(D^97H zH!?CZe9oJNvS4i^+gGouJ1gcl}@)R+yL(&OT6Sc%s+HWb3y*x2L}85QN^e0DNC92Wc8E%EU19@j#}9a_%% zUoZ?kD8Yr_xR6Az88og zBOPoPW@S}WR5(~zkDUPrKL@r5mYv`wi$hlPb5EqJ(cbRd?r(HBhDp>)Gz3^nOG`}^ zT~?f_ihDInUq(MzqvX!u{Diz_G2A>k$x3aizBjq=kENj}7|d5lBftXFf7u@X{r&rQ z@lZU221gV49c*iBD>(Qw9^MtoORn_+5)6~M`FU?|@BI8@#5*qS$V(GvB_tRatr#ob z!mlSL3X~}L*!e$v@K|Z{b=etJkdYa)s!2#l5K0UomiU|Qfy%6X;2#`Dh4=FRi+|+* zxa2J&&fTVLNCCa3w>LL9?!42{8cnX=-$g0$F?{Xk>+C2Ro0^b15XeYk)cGc^?@twy zD+gU!@$U|St@zz5=+0kL_&+$w%gbjKBlhUo^L!Yu7k1!B@lo)r7cVN^4no;e1i84} zF1D`~vxJ$FhVIpgLQLL`D}S{AtY-nis zRrqOl%PO8|X$1wYj4JDi?Y=(AR>S8&PEJm6a4_`8)37mXyzJJm_mR-3@Z0mDR#~v~)?oZp ziPq8l6zrP_aY*a!HW_lDG5ih}2?@!e?N;*37Y!E|7bx=m$+@5g4pUN0Ss4=`Xn!3U z9c|~}AmV;Vob{*u>#eMx-y;Ir@}Z0*4zB!Vl6h;V#z4tN6)}8D9PWqAL;3>XCeI= z0vW|W_jm^#ejkDoqCMH1^mOqL+SL2@I1rs`qiH)2SA$fUu64YLT z97#jHtcO`oi#GG`@iD;Qe)Xk~A&GJYjg2~V1d8drl`SnTW=*1h`M=&cUX({ha%8P| zZP8YrNmk5|;h@VYVakG4Y2yS01hllYPyz;gX6NT?E9L2Irw(8xTJ5Fk3_kW$xhN>E zAN5;2RU{-NelU~gjd|Xju6_T0#?scn{_b7R)YN+h1_o+s>W?201)Wj9;qSnJ^?DB` zqAVvd8&s)>8CL9E+?qjSYU}H-FD`rp#U&;CazA4SefuUTB&1a?--w8`HX}L!R^2-| z5U0c^zzU9wqlxS-E-Ndks4!~vt}Q4C&B!oN#y@{{`8u~%=vb2hv5y0BAC8t=3wYX6 zLqhtRJ+L>{`$keYEaz*i{ruWSMwq~0aBpv~TK+p`ZAiz|6s-BAjfI{bDIhzWQcEid zQ7e&wq#;D{`}%O>1gxHUBEY7osOau--QW!a>Few3>80%v0CY@DTaLVuubI+$olHM} z?!8_qNZBl(IoSSV4*f^3j2R>;eXbGe@B<%qptW*YhTOTIf$cm8=J}^wBii=+g;jsCh)~^z7~wI zrpU{^f+WjJCWU^>Br&*hIX_gk}cStDYfB({pBy)C8@2ZUsWA3bnGSJa^KHlzNpqd&OWc*9XQB#{f zJ;DvzdRH7I;~_OFs@KNlkWD`u(Q|1uqjAIT=Q^x?Tz&1vM&3(c(?4gOF)!XK@Ff7O z?i+6a#wVj4&?wPh>U`s)BGrW%yT~2*a7SO|bEIT(S4AL(+^T@*45+rKNC1I>_q4RB zs=wmmy1TmC9?s>0I{&7Z7)6doZ#qo&Qtr(`Rub=m`TI6`uqNca;pnf!Kn2{mdK6`EgOJv5xQ z_a?j@vK}tpJ>jPEwxIO0S1y@as6UaGCPqB6+GVGFxdaPnq5W=3+}EsDpk~d*&NY!@ zCu_-DjU-ARPyZR~WwiW;py`{kc3p3$ZvP?wMnd=?LB3pt=FR6z7L-euAX)Hy)mFEm z1uaJ*Cv%*=!-injg8z2dc$Nc$9vD#esN^;O6eUYH#lY3A`Hpj?STmB4w5X~zgaW2& zIuOfPCZ>=dS1ZdDuBd|X?w5DY7>4H$k)K%eAs-MQ-CiHQ1+?>(sUQg$( zh$uX(1b|5#j3;nJ+#9IPL`g2AR4hw~Em?25$srRUX_b zNlg^yYKJ+fdRm5X9c6?cNMonFkr~1|O&!1YnzJ)eh}j4U;^M?qoDM7sBvPtMQ(;3J zpy)`%Wb8w7F&1R7AM%A1)qdOy(7@r}^f&ACQR}IfV!MOTz+EYHDQzQPH)90vzI(Zc zpr7rY-@kt&w9!&?v*C0;*|+UpUP0gq~ zz)pWWretdlcU~byY9M5I6=P^~S*PBfDO_T(zaI$L+}!Nw=n(R`a@|-aNo04LJx86W zYwYd}LtUYNf%c4DJ|zAB-J5i!eX5=n3G^vA^i;ek15I!*44F)laR34GAL6VwV=EN6 zNDGjGkWW5#J5$R1)OJ>8ymOa&9Qdz^hdp?b7X=V(6(g3j8|@>-q%x@YcD9|4vB_GT zM(rRzwZ$KNVLx+~ui6w8Eo<)NCMMy}*3W{r7v}?g37e4>CxU_!NYRYsw^$L`qgjr~ z8k`S$?2-8iML>sB@{e2%$$B%iVNxeV*!?ib$C$*A?KqS=S}Cf(?LZ~k)1|jqHSDVN zeEvk*+>A6PWNrk}7>0f1{fPwN<=8L3>c-JE=#D;*SUG!cj(PKZp(W;rHLPzL=a8*RPIP%Ns9hgtz0 zraGeUYu+_X(%e-X}osTEcG&HKN%dk{R6 z7XuOu(bH_fec3vL54`WFJ7Y)oPqH6hLUz>`+Vnvj(^QP?DQ|e*k4_EY0<6eXl$?$d zhyBZ0nRojwW%S}_Ye|xOUIU3SUdf!Yy=%{DCD2w$CTaBV&&yKGy0ca#4)9+C%7yWT zV=87J`udc@pJQNC;@`1CK~{>;RD42Z_g%Q~R%{99O6F*>?cuTS1|0k9_l$kmD6|R{ zn#nOsbxB6R9{zV?=gKql&tqDQr7}Du0kh=Vlh^sGy_Q#ayj_QGY!5brO;IX{Prlm- z-)el(X3xdcRc2lAXLA_^co_@X3*KWHji}90W7$k#n!j7xT5@>wWIHK|n?YL5OQ?QW zd}B15xP1Wf_q=ds`M?|}*=R85$zO1D+oR%Fjt7RdY-K$vYyNo#cs#p`(b`sc^OlZa zsE%CtdZSkmn5`1rYaGaX!^fDh?0D(?cn5DUtmOwF^t_>90#;rMU7p-yETQc!xy@q(6AN zHB^+e;#Mo<->m!Z-76WMc%aMl~!BzlECJlpM)tXAh+ z_s_#07p~#nF#nSRoC_C}fD!++HplfaqB`;@{o8>jxMQDcrT%L(i2&%VmWKo!&XFVW zIKTLPrd{wg>{^Ko)o#JaZ#sTQBu&ezrfD}xc;Rxy;n_4ZrlSXHfXU-=`wl^9fvwMW zD~gO+mtiW`XuJ+xtjmt==IC4lydMp?xl^~el*@|t^J>Nos{3*~%zTmTb>c9QMNR?h zf)xZ=?+Oj2jM(1+4~?75|*hB9)~Fe^t`Z1Pb=M!%Vdc2a<$ z!}r+dDaNS!N&iho20u7X z+MLJ1gGi~K`I)lHqkU{!xy{v^j}EIl2{S9@wya>5bk=V(w70u|=lC;sLoXT&Tq4ze znIf(Brfdky3;4D|iYqnr)hFg+#=`qForKzt7AAPC2+pH(_Yv3MbIgr>$^=;XXKh@= zW}4t4Jdy7{I1p@WP5vP!2l30ji>(j)J$DWAZ_;OF9{;1Cs#~IFG*dlkgaDu>YOOGr1UA68Z3 zK}_uin)(Y5L$v~?jl~UhjSY3T<`y|cm=_;#DnKCkIuzSYaO_qOj9giIUt$uT?ospKR;61Cgg<;Vo)S_0 z@^K^}N(krnvnpDgB%59RKzzQXvz8BchzVh6eeyUau{&aaCc<0X_fAEBK(TvR4}-pN zWGcP+VmYK<$o1{&SXkwC2FS9T6>3X5>LajF8$n^s-mWlMTe(X~BtzK!miyC-;{z<< zEnYf*W?@>f&ww(~Yd}3oO4N~amo+U{Oxvq z$*dRU?agN7O7AoZzsS}i{&rH3lL0jY1kCPrOTk~h-t?Grk}52~9=KaOS8H#4Cyc>z zIOsI!#6TgZF2n5_EbA57*|pBb%b8;)ht+~%;`{k(%pW^!G-|~Qzp+GkLLVZ$0oEnQ zlZ$!&nJ=8CiCNF1Bs(5&?vm?IE*30$zU%OVuW?{{IpGoO5vk{(i}Eq6hBTkF8S}B9 zYT6U=z7(@0%^E_^^S90c`_dr zL&s8}5W_4sP)?*NBJyQ&mX(4?fJ{Iy(jk7g=cu?ZH+38Cz=V0>?u0N^aWD30UEJb+ z%H#>YBHG&;#yxkWe#x5mB1}RIN>R?gwdZ+PUr=4gs1$(-!-Kic!S5bkr35c6)~Q-V z!7ss^%baVoTVJK{4lbtt+%(Pm@H<&=e$an2hvm)q>Pzq!;@I7d6FW}Q%-3N zTF(QIta4f5+W`=FT%SYS5qt{^!04%(J2`$bg)MSj(5mxbXRRc<7Zkq$mhZ24$~66r zk6aLucz>;DY9zPhu@1@(-56tHsoIU#tbDkyo@>P%x8fXqT1`XLQJ=dDEge_c&q0)H zBTKp&Z9~J+Wk(d`{LR029}%a$W~)3sP|Xn195 zwx1USRs##6&pqK}8w{jAen$sF(i|$zNusyfm-n}M1Lb?}OeqhD__gNMeriVlL&E>d zXil7-%7IuR#t|q1hz4TNzm@A8ws+N8PC%9l`OS84u~KL&*)x8IXdd~&`NyhGTSdru zofrU~iGA$Q2i7-s;ArXyrX}^6o98<-mWea@M988D+dRMe2%*xDfCVU<^JiozRE0)u z>qO4KMb+ge>PsrmW#S((hmA}PATq(EPr5OjJXvn$uyyf`B6mTTw4-Iit| zMd%!6jU%N;9Xx5cF!-?$7WLeezZ$Gy=k+AWVgsrsI0a58v4(IK76Lt*^B*MMb`Q8; zrjm^3*X>t(0HQQ%;C3f`0LL2zXoxy(yMPmZGHJCY=DZsr(G9+vpWbj~=0Ipm{)F=F z2LsY1J_~sI`75tzoip$`ocV`Uw`YUvT?n7%WRL1ifNQBp8!G*0_AT{i~(16=rDG>u@U^z6Pvvb1RR= zsi!x9@uhD(j%|KN*fY41krmo&#lIO*IekCwogOq4gp zT=85p@4KfID=a5#P?ZzTqBXmfql?o2qDLKXio6aZ_*GacL-lj9{p*j7gUOkI`=lIZ z#vo1cS{L`UrUo_sxsVOvBfcO_yF<_!tsKGvVXxlN(q|>NgMrG5;hj**o!SXvq zEkTGeYX;w-COtr>2WHed-Zl}7cm{k#h~d-n3{dOs-)FX*yJU*KEc7g%>&RPzn6a|X zunhU1Uqy4l@)iRErTo*$rmpiSU*>^V4Jxm|ur7hE-y_R-Qq~>Zo%N zlQ3P|v$`!Vdd7!ar&jCye_pMGq@`Z}k&q_#NJ^fS^b)uIiIUmJSpz9RmF}ZJCRwdB zvgEtT-$aRThrBi+W1cpD=1##IPzRlCwc?ULM5&oKlct}i3qEvbM#|0BVRW;Cm5Xf? zkVIjPV)-1F!+IRy>Q%bMrR`sz1L}6?WLcRw{(k8vlhQ$>%3p7E;V^c&ghY5c3UQP^ zM}{c%ITk4LX~8RcE(RiWWarDT*WKKs+JVyX*Fes4vwydx#*G*wU>B8!)6iu zcBiNlyM)thePY_=|3^#t@5f%#RHZq4<0K&EIh-h7b>Y7`FQu+8 zr@$9P-v=$^pR}-|?as&tP@<+Dw5*)>W^pN$epeQ{#}rTJA73;_pFK|%NL@28Q3LhX zeoONiC9b*CSt%b}NLv1-Wj45xg8#D0ILf-*@gdPmHdfH#gwF+&7%2^67Yk_tvmRjq z2xB68iS^)oJ8#_E1ga}pmg00=dooh3FYP)wDKwO7ueox2m&>O&>$34+A@L#%HCmnC zjzA-$ap{*98GK)z%;PxWIwo)o1CSu~8XN_0wQo-UCKBp|kwo!nEt!xDC6a`su}qCt zLT%-V6fa9A_A3(g=e}-kmrsl|YM|TAI3#n4Z&WQpQ5_%NDoUM&J+Ff~XIE0lzsPq< zAr8c^^DN~O~fniu-o`+c9r>m5sS@V^XA;srA+ZHmB9z+_Y8DS30<>RlxV% z2T>d>8l4TKggiUjpQ7lZ)pgR&;#;sMK;EUoCL5!j0B9T=mp|xDkDW%#Tcw;Tl5gvM zt6pq;0*Xk0zbtBR*gfhLz$sB^*K@w?)Ms9??naKwlTokQeC+n)&S^w^ zAb_g$&$j@sbjDwVG+AC~oYr8u4bSV?u4FdzAO>iK66}?S1-AG2JazR5cIdqc8q{H<a3nvXXtJ^$dp^VLz(4-e;Oqml_7lfsFwC5pJX*pF7G%Z{YrB}=h)Kb8 zIM%0Vp@JkjJ#OexH0wW&0i0&>wVc-@N2|jiP}6Zvb~jj~Kuqjgd94_^8lG4&&~W+W z;MAl@&kh%T4We`yg6)P&5w`u)$TWbYn zk{_`TR_y+D^TdhP&x@tI_1J%Rt(PE{lKx?Pr6_I^d#+6pSmhILc+{0qvriDCv~Ha9 zvPG}@lo*KELZb!4t4V*ZybY%|my9XZ^p%0wku9r(+@Ic0g= z5Os+l^n9ljT%N%iXToqvZZ|>m*PlOX74=5k*?f7FQF)Z<{;0IVy^o7W4J1G|R$hI2lZ$FnUrWw!Btb#S{z#}q&6=Ygo(uAU?BYHtX4DwYI+jhQkH05P ziMR>Hlqyh;+a&<9=PC)1t&Ny>I!w^a7!f>zoU+O5E(z^1Y;wH>+0C8l|GB}3VkkKo zlniiS%q8UK)n#5ew-Er+t`P$V1q1`S_EQpYU)8;{H1v#51>>f~lDTR%&Ri*~(yP&@E$!1}?sbYZObK7L+s8~Y9|;YN@RM+Af7X38Lyvh*tv z!%bo4hW$$#r^GiSnJsX%>se8?m1#`&IR5pmp7A`sUw4_$Hfl*ev)NdNGw7lQ!(2mi zYEzrsFtG1-$Ei39GhcOeJ-t?+_cqbmuyq1?&$ zT5>|rP}i483=RvejlVN$rPb7@Cm*hWuNSM!`=NWAz$! z$#;`Ez(4b&e^JlocqMJfof=h_?5F=-{Ij}dVZG4A-LL$Q5mNBeGqv|WT$y*>lM&w@ O0WzNzCCbH&zx@x>S7+1! literal 0 HcmV?d00001 diff --git a/Docs/introduction.md b/Docs/introduction.md deleted file mode 100644 index 46fca38..0000000 --- a/Docs/introduction.md +++ /dev/null @@ -1,21 +0,0 @@ -# Introduction - -The **Dashboard** module is one of the essential core modules that is always required. This module is responsible for providing a personalizable dashboard after login. - -## Target Group - -The target group for this module is everyone. - -# Setup - -The module can be installed through the integrated module downloader and installer or by uploading the module into the `Modules/` directory and executing the installation through the module installer. - -# Features - -## Customizability - -The dashboard can be custamized by every user according to his/her needs. It's also possible to define default dashboards for different user groups which can be used by users. This allows the administrator to provide default dashboards which then can be used without manually creating a dashboard. - -## Extendability - -All modules can provide one or multiple dashboard components which can be integrated in the dashboard. \ No newline at end of file