RenderApplicationDocumentation < Applications

You are here: Foswiki>Applications Web>TopicType>TopicFunction>RenderApplicationDocumentationEditAttach

---++ Documentation
%STARTSECTION{"documentation"}%
---+++++ Parameters
   * NAME: application name, defaults to BASEWEB
   * THEWEB: web to search for docu, defaults to BASEWEB
   * TYPE: extract documentation of topics of the given type
   * NOTTYPE: don't list topics of that type

---+++++ Css
   * twbDocuHolder
   * twbDocuSectionHolder
   * twbDocuSectionSummary
   * twbDocuSectionText
%ENDSECTION{"documentation"}%

---++ Implementation
<verbatim class="tml">
%STARTINCLUDE%<!-- render application documentation -->
%DBQUERY{
   "WikiApplication='\b%IF{"defined NAME" then="%NAME%" else="%EXTRACT{text="%BASEWEB%" pattern=".*/(.+?)$" format="$1"}%"}%\b'
   AND TopicType=~'\b%TYPE%\b' 
   %IF{"defined NOTTYPE" then=" AND !(TopicType=~'\b%NOTTYPE%\b')"}%"
   web="%IF{"defined THEWEB" then="%THEWEB%" else="%BASEWEB%"}%"
   hidenull="on"
   remote="off"
   header="<div class='twbDocuHolder'>
---+++ %TYPE%$n"
   format="<div class='twbDocuSectionHolder'>
---++++ <nop>$topic
<div class='twbDocuSectionSummary'>$formfield(Summary)</div>
<div class='twbDocuSectionText'>$expand(_sectiondocumentation) ... [[$web.$topic][read more]]</div>
</div>"
   separator="$n"
  footer="</div>"
}%
<!-- //render application documentation -->%STOPINCLUDE%
</verbatim>

---++ Test
%DBCALL{"%TOPIC%" NAME="WikiWorkbench" TYPE="TopicFunction"}%

%DBCALL{"RenderFunctionCallers"}%

---++ Copyright
&copy; 2006-2013 Michael Daum http://michaeldaumconsulting.com

%DBCALL{"GnuGeneralPublicLicense" section="notice"}%

ApplicationTopic edit

TopicType	TopicFunction
TopicTitle
Summary	Extracts the documentation section from all parts of a WikiApplication
WikiApplication	WikiWorkbench

Topic revision: r1 - 23 Dec 2012, ProjectContributor

Applications

Tools

Das Urheberrecht © liegt bei den mitwirkenden Autoren. Alle Inhalte dieser Kollaborations-Plattform sind Eigentum der Autoren.