^L
# Function    : describeProperty
# ----
# Returns     : 
# Parameters  :    template - 
#                  property -
#        element of the »template« interface.
#               description - for »property«.
#               
# Description : 
#
# Used during designing a  template interface.
#
# Jeszra automatically asks for the given
# »property« description when the property
# is undocumented.
#
# This »property« description gets
# then stored inside the predefined
# DocBook directory.
# Written     : 06/14/2008, Roger
# ----
proc describeProperty {
    template property description 
    } {

                

return [subst {
        <varlistentry>
    <term>Command-Line Name: 
      <emphasis>-[string tolower \
                     $property]</emphasis></term>
    <term>Database Name: 
      <emphasis>$property</emphasis></term>
    <term>Database Class;
       <emphasis>-</emphasis></term>
          <listitem>
            <!-- Generator : Jezsra.
             Description defined inside for
              template interface: $template.
              -->
            <para>$description</para>
           </listitem>
        </varlistentry>
<!-- 
Local Variables:
mode: xae
coding: utf-8-unix
sgml-parent-document: ( \
    "refentry${template}.xml" \
    "variablelist" )
sgml-insert-missing-element-comment: nil
End:
-->}]
}

                

^L                    
# Function    : startproc
# ----
# Returns     : 
# Parameters  : 
#
# Description : 
# The start sequence for the function comment.
# These sequence is located inside the
# code-buffer  and then–with the start
# location as its anchor point– the end
# sequence is searched. Everything between
# is then used for the commentary of the 
# Tcl-procedure in question.
#
#       %1 stands for the template namespace.
#       %2 stands for the procedure name.
# Written     : 06/14/2008, Roger
# ----
proc startproc { } {
return \
{^L
# Function    : %1$s::%2$s
# ----
}
}

                

^L
# Function    : endproc
# ----
# Returns     : 
# Parameters  : 
#
# Description : 
# Paired with startproc. seeks the start of
# the procedure definition after the
# procedure commentary, which is used for
# the documentation. Important words are:
# »Description« and »Written«.
#
#       See also »startproc« and »describe«.
# Written     : 06/14/2008, Roger
# ----
proc endproc { } {
return \
{# ----
proc %1$s::%2$s}
}

                

^L
# Function    : startcommentary
# ----
# Returns     : 
# Parameters  : 
#
# Description : 
# Searches the term »Description« in a
# procedure commentary. These term marks
# the begin intended for the documentation.
#
#          %1 and %2 may be used here, too.
# Written     : 06/14/2008, Roger
# ----
proc startcommentary { } {
    return {# Description : }
}
 
                

^L
# Function    : endcommentary
# ----
# Returns     : 
# Parameters  : 
#
# Description : 
# The endcommentary denotes the point inside
# the procedure comment, where the normal
# description ends. Usual there is some
# revision information left, indicated by
# this sequence. The revision code is
# verbatim added to the documentation.
#
#               %1, %2 are allowed.
# Written     : 06/14/2008, Roger
# ----
proc endcommentary { } {
    return {Written     : }
}

                

^L
# Function    : entities
# ----
# Returns     : 
# Parameters  : template - not used
#
# Description : 
# Provide a quick access to the entity of a
# stand-alone man-page. The »entity«
# definition is out-commented I assumed the
# refentry is used as part of a larger
# document and derives its entity definition
# from the top-most document. Alter this,
# if needed.
#
# This must be the first line inside a DocBook
# document!
# Written     : 06/19/2008, Roger
# ----
proc entities template {
    return {<?xml version="1.0"
                 encoding="UTF-8"?>
<!--
<!DOCTYPE refentry PUBLIC 
"-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml\
 /4.5/docbookx.dtd">
-->
}
}