[otrs-cvs] CVS: doc-developer/en additional-resources.xml, 1.2, 1.3 book.xml, 1.2, 1.3 config-mechanism.xml, 1.2, 1.3 database-mechanism.xml, 1.2, 1.3 language-translations.xml, 1.2, 1.3 log-mechanism.xml, 1.2, 1.3 module-format.xml, 1.2, 1.3 object-basics.xml, 1.2, 1.3 package-building.xml, 1.2, 1.3 templates.xml, 1.2, 1.3 writing-otrs-application.xml, 1.2, 1.3

cvs-log at otrs.org cvs-log at otrs.org
Thu Aug 11 17:10:00 CEST 2005


Update of /home/cvs/doc-developer/en
In directory osser:/tmp/cvs-serv27936/en

Modified Files:
	additional-resources.xml book.xml config-mechanism.xml 
	database-mechanism.xml language-translations.xml 
	log-mechanism.xml module-format.xml object-basics.xml 
	package-building.xml templates.xml 
	writing-otrs-application.xml 
Log Message:
fixed syntax errors

Index: additional-resources.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/additional-resources.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** additional-resources.xml	10 Aug 2005 14:17:04 -0000	1.2
--- additional-resources.xml	11 Aug 2005 14:09:58 -0000	1.3
***************
*** 7,15 ****
      <sect1 id="online-library">
          <title>Online Library</title>
!         <ulink url="http://dev.otrs.org/">http://dev.otrs.org/</ulink>
      </sect1>
      <sect1 id="developer-mailing-list">
          <title>Developer Mailing list</title>
!         <ulink url="http://lists.otrs.org/">http://lists.otrs.org/</ulink>
      </sect1>
      <sect1 id="commercial-support">
--- 7,19 ----
      <sect1 id="online-library">
          <title>Online Library</title>
!         <para>
!             <ulink url="http://dev.otrs.org/">http://dev.otrs.org/</ulink>
!         </para>
      </sect1>
      <sect1 id="developer-mailing-list">
          <title>Developer Mailing list</title>
!         <para>
!             <ulink url="http://lists.otrs.org/">http://lists.otrs.org/</ulink>
!         </para>
      </sect1>
      <sect1 id="commercial-support">

Index: book.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/book.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** book.xml	10 Aug 2005 14:17:04 -0000	1.2
--- book.xml	11 Aug 2005 14:09:58 -0000	1.3
***************
*** 14,33 ****
          <legalnotice>
              <para>
!             Richard Kammermeyer, Christian Sch?pplein, Stefan Rother, Thomas Raith, Burchard Steinbild, Andre Mindermann, Martin Edenhofer
              </para>
              <para>
!             This work is copyrighted by OTRS GmbH.
              </para>
              <para>
!             You may copy it in whole or in part as long as the copies retain this copyright statement.
              </para>
              <para>
!             UNIX is a registered trademark of X/Open Company Limited.
!             Linux is a registered trademark of Linus Torvalds.
!             MS-DOS, Windows, Windows 95, Windows 98, Windows NT, Windows 2000, Windows XP and Windows 2003 are registered trademarks of Microsoft Corporation.
!             Other trademarks and registered trademarks are: SUSE and YaST of SUSE GmbH, Redhat and Fedora of Red Hat, Inc.
!             All trade names are used without the guarantee for their free use and are possibly registered trade marks.
!             OTRS GmbH essentially follows the notations of the manufacturers.
!             Other products mentioned in this manual may be trademarks of the respective manufacturer.
              </para>
          </legalnotice>
--- 14,45 ----
          <legalnotice>
              <para>
!                 Richard Kammermeyer, Christian Sch?pplein, Stefan Rother, Thomas Raith,
!                 Burchard Steinbild, Andre Mindermann, Martin Edenhofer
              </para>
              <para>
!                 This work is copyrighted by OTRS GmbH.
              </para>
              <para>
!                 You may copy it in whole or in part as long as the copies retain this
!                 copyright statement.
              </para>
              <para>
!                 UNIX is a registered trademark of X/Open Company Limited.
!                 Linux is a registered trademark of Linus Torvalds.
!             </para>
!             <para>
!                 MS-DOS, Windows, Windows 95, Windows 98, Windows NT, Windows 2000, Windows XP
!                 and Windows 2003 are registered trademarks of Microsoft Corporation.
!                 Other trademarks and registered trademarks are: SUSE and YaST of SUSE GmbH,
!                 Redhat and Fedora of Red Hat, Inc.
!             </para>
!             <para>
!                 All trade names are used without the guarantee for their free use and are
!                 possibly registered trade marks.
!             </para>
!             <para>
!                 OTRS GmbH essentially follows the notations of the manufacturers.
!                 Other products mentioned in this manual may be trademarks of the respective
!                 manufacturer.
              </para>
          </legalnotice>

Index: config-mechanism.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/config-mechanism.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** config-mechanism.xml	10 Aug 2005 14:17:04 -0000	1.2
--- config-mechanism.xml	11 Aug 2005 14:09:58 -0000	1.3
***************
*** 26,30 ****
          </para>
          <para>And could look like the following:</para>
!         <filename>Kernel/config/Defaults/Files/Calendar.pm</filename>
          <programlisting format="linespecific" language="Perl">
              # module reg and nav bar
--- 26,32 ----
          </para>
          <para>And could look like the following:</para>
!         <para>
!             <filename>Kernel/config/Files/Calendar.pm</filename>
!         </para>
          <programlisting format="linespecific" language="Perl">
              # module reg and nav bar
***************
*** 59,62 ****
--- 61,71 ----
              <filename>Kernel/Config.pm</filename>
          </para>
+         <para>
+             and set the new option. This file will be used at least and so all default config
+             options are overwritten with your settings.
+         </para>
+         <para>
+             This way it's easy to handle updates, you just need the Kernel/Config.pm.
+         </para>
      </sect1>
      <sect1 id="accessing-config-options">

Index: database-mechanism.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/database-mechanism.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** database-mechanism.xml	10 Aug 2005 14:17:04 -0000	1.2
--- database-mechanism.xml	11 Aug 2005 14:09:58 -0000	1.3
***************
*** 50,54 ****
              <note>
                  <para>
!                     Note: Take care that you use Limit as param and not in the SQL string because
                      not each database supports LIMIT in SQL string.
                  </para>
--- 50,54 ----
              <note>
                  <para>
!                     Take care that you use Limit as param and not in the SQL string because
                      not each database supports LIMIT in SQL string.
                  </para>
***************
*** 72,81 ****
              </para>
              <programlisting format="linespecific" language="Perl">
! 
!                 <Insert Table="some_table">
!                     <Data Key="id" Value="1"/>
!                     <Data Key="description" Value="exploit" Type="Quote"/>
!                 </Insert>
! 
              </programlisting>
              <para>
--- 72,79 ----
              </para>
              <programlisting format="linespecific" language="Perl">
!                 &lt;Insert Table="some_table"&gt;
!                     &lt;Data Key="id" Value="1"/&gt;
!                     &lt;Data Key="description" Value="exploit" Type="Quote"/&gt;
!                 &lt;/Insert>
              </programlisting>
              <para>
***************
*** 83,106 ****
              </para>
              <programlisting format="linespecific" language="Perl">
! 
!                 <TableCreate Name="calendar_event">
!                   <Column Name="id" Required="true" PrimaryKey="true" AutoIncrement="true" Type="BIGINT"/>
!                   <Column Name="title" Required="true" Size="250" Type="VARCHAR"/>
!                   <Column Name="content" Required="false" Size="250" Type="VARCHAR"/>
!                   <Column Name="start_time" Required="true" Type="DATE"/>
!                   <Column Name="end_time" Required="true" Type="DATE"/>
!                   <Column Name="owner_id" Required="true" Type="INTEGER"/>
!                   <Column Name="event_status" Required="true" Size="50" Type="VARCHAR"/>
!                   <Index Name="title">
!                     <IndexColumn Name="title"/>
!                   </Index>
!                   <Unique>
!                     <UniqueColumn Name="title"/>
!                   </Unique>
!                   <ForeignKey ForeignTable="system_user">
!                     <Reference Local="owner_id" Foreign="id"/>
!                   </ForeignKey>
!                 </TableCreate>
! 
              </programlisting>
              <para>
--- 81,102 ----
              </para>
              <programlisting format="linespecific" language="Perl">
!                 &lt;TableCreate Name="calendar_event"&gt;
!                   &lt;Column Name="id" Required="true" PrimaryKey="true" AutoIncrement="true" Type="BIGINT"/&gt;
!                   &lt;Column Name="title" Required="true" Size="250" Type="VARCHAR"/&gt;
!                   &lt;Column Name="content" Required="false" Size="250" Type="VARCHAR"/&gt;
!                   &lt;Column Name="start_time" Required="true" Type="DATE"/&gt;
!                   &lt;Column Name="end_time" Required="true" Type="DATE"/&gt;
!                   &lt;Column Name="owner_id" Required="true" Type="INTEGER"/&gt;
!                   &lt;Column Name="event_status" Required="true" Size="50" Type="VARCHAR"/&gt;
!                   &lt;Index Name="title"&gt;
!                     &lt;IndexColumn Name="title"/&gt;
!                   &lt;/Index&gt;
!                   &lt;Unique&gt;
!                     &lt;UniqueColumn Name="title"/&gt;
!                   &lt;/Unique&gt;
!                   &lt;ForeignKey ForeignTable="system_user"&gt;
!                     &lt;Reference Local="owner_id" Foreign="id"/&gt;
!                   &lt;/ForeignKey&gt;
!                 &lt;/TableCreate&gt;
              </programlisting>
              <para>
***************
*** 108,116 ****
              </para>
              <programlisting format="linespecific" language="Perl">
! 
!                 <DatabaseUninstall>
!                   <TableDrop Name="calendar_event"/>
!                 </DatabaseUninstall>
! 
              </programlisting>
              <para>
--- 104,110 ----
              </para>
              <programlisting format="linespecific" language="Perl">
!                 &lt;DatabaseUninstall&gt;
!                   &lt;TableDrop Name="calendar_event"/&gt;
!                 &lt;/DatabaseUninstall&gt;
              </programlisting>
              <para>

Index: language-translations.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/language-translations.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** language-translations.xml	10 Aug 2005 14:17:04 -0000	1.2
--- language-translations.xml	11 Aug 2005 14:09:58 -0000	1.3
***************
*** 9,13 ****
          in the frontend.
      </para>
!     <sect1 id="how-it-works">
          <title>How it works</title>
          <para>
--- 9,13 ----
          in the frontend.
      </para>
!     <sect1 id="lt-how-it-works">
          <title>How it works</title>
          <para>
***************
*** 54,58 ****
                  # --
                  # Kernel/Language/de.pm - provides de language translation
!                 # Copyright (C) 2001-2004 Martin Edenhofer <martin+code at otrs.org>
                  # --
                  # $Id$
--- 54,58 ----
                  # --
                  # Kernel/Language/de.pm - provides de language translation
!                 # Copyright (C) 2001-2004 Martin Edenhofer &lt;martin+code at otrs.org&gt;
                  # --
                  # $Id$
***************
*** 116,120 ****
                  # --
                  # Kernel/Language/de_AgentCalendar.pm - provides de language translation
!                 # Copyright (C) 2001-2004 Martin Edenhofer <martin+code at otrs.org>
                  # --
                  # $Id$
--- 116,120 ----
                  # --
                  # Kernel/Language/de_AgentCalendar.pm - provides de language translation
!                 # Copyright (C) 2001-2004 Martin Edenhofer &lt;martin+code at otrs.org&gt;
                  # --
                  # $Id$
***************
*** 159,163 ****
                  # --
                  # Kernel/Language/xx_Custom.pm - provides xx custom language translation
!                 # Copyright (C) 2001-2004 Martin Edenhofer <martin+code at otrs.org>
                  # --
                  # $Id$
--- 159,163 ----
                  # --
                  # Kernel/Language/xx_Custom.pm - provides xx custom language translation
!                 # Copyright (C) 2001-2004 Martin Edenhofer &lt;martin+code at otrs.org&gt;
                  # --
                  # $Id$

Index: log-mechanism.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/log-mechanism.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** log-mechanism.xml	10 Aug 2005 14:17:04 -0000	1.2
--- log-mechanism.xml	11 Aug 2005 14:09:58 -0000	1.3
***************
*** 8,10 ****
--- 8,42 ----
          OTRS comes with an log backend which can be used for application logging and debugging.
      </para>
+     <sect1 id="use-and-syntax">
+         <title>Use and Syntax</title>
+         <para>
+             In all module layers is already an existing Log Object which can be use by
+         </para>
+         <programlisting format="linespecific" language="Perl">
+             $Self->{LogObject}->Log(
+                 Priority => 'error',
+                 Message => "Nee something!",
+             );
+         </programlisting>
+     </sect1>
+     <sect1 id="example">
+         <title>Example</title>
+         <para>
+             The following is a example to use the log mechanism without a module layer.
+         </para>
+         <programlisting format="linespecific" language="Perl">
+             use Kernel::Config;
+             use Kernel::System::Log;
+ 
+             my $ConfigObject = Kernel::Config->new();
+             my $LogObject    = Kernel::System::Log->new(
+                 ConfigObject => $ConfigObject,
+             );
+ 
+             $Self->{LogObject}->Log(
+                 Priority => 'error',
+                 Message => "Need something!",
+             );
+         </programlisting>
+     </sect1>
  </chapter>

Index: module-format.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/module-format.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** module-format.xml	10 Aug 2005 14:17:04 -0000	1.2
--- module-format.xml	11 Aug 2005 14:09:58 -0000	1.3
***************
*** 164,168 ****
                          Name => 'Text',
                          Image => 'new-message.png',
!                         Link => 'Action=AgentMailbox&Subaction=New',
                          AccessKey => 'j',
                  };
--- 164,168 ----
                          Name => 'Text',
                          Image => 'new-message.png',
!                         Link => 'Action=AgentMailbox&amp;Subaction=New',
                          AccessKey => 'j',
                  };
***************
*** 184,188 ****
          </programlisting>
      </sect1>
!     <sect1 id="frontend-module">
          <title>Frontend Module</title>
          <para>
--- 184,188 ----
          </programlisting>
      </sect1>
!     <sect1 id="frontend-modules">
          <title>Frontend Module</title>
          <para>
***************
*** 315,319 ****
              Description of Frontend::Module options:
          </para>
!         <informtable>
              <tgroup cols="2">
                  <thead>
--- 315,319 ----
              Description of Frontend::Module options:
          </para>
!         <informaltable>
              <tgroup cols="2">
                  <thead>
***************
*** 343,349 ****
                  </tbody>
              </tgroup>
!         </informtable>
!         <para>Descriptio of NavBar (icon points) options:</para>
!         <informtable>
              <tgroup cols="2">
                  <thead>
--- 343,349 ----
                  </tbody>
              </tgroup>
!         </informaltable>
!         <para>Description of NavBar (icon points) options:</para>
!         <informaltable>
              <tgroup cols="2">
                  <thead>
***************
*** 381,387 ****
                  </tbody>
              </tgroup>
!         </informtable>
      </sect1>
!     <sect1 id="core-module">
          <title>Core Module</title>
          <para>
--- 381,387 ----
                  </tbody>
              </tgroup>
!         </informaltable>
      </sect1>
!     <sect1 id="core-modules">
          <title>Core Module</title>
          <para>

Index: object-basics.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/object-basics.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** object-basics.xml	10 Aug 2005 14:17:04 -0000	1.2
--- object-basics.xml	11 Aug 2005 14:09:58 -0000	1.3
***************
*** 15,19 ****
              like this naming in the application and in the database.
          </para>
!         <informtable>
              <tgroup cols="2">
                  <thead>
--- 15,19 ----
              like this naming in the application and in the database.
          </para>
!         <informaltable>
              <tgroup cols="2">
                  <thead>
***************
*** 70,74 ****
                  </tbody>
              </tgroup>
!         </informtable>
      </sect1>
      <sect1 id="search-options">
--- 70,74 ----
                  </tbody>
              </tgroup>
!         </informaltable>
      </sect1>
      <sect1 id="search-options">
***************
*** 225,229 ****
              Tabelle 2Menu functions - global, always used
          </para>
!                 <informaltable>
              <tgroup cols="4">
                  <thead>
--- 225,229 ----
              Tabelle 2Menu functions - global, always used
          </para>
!         <informaltable>
              <tgroup cols="4">
                  <thead>
***************
*** 243,250 ****
                      </row>
                      <row>
!                         <entry>SIRIOS-Project</entry>
!                         <entry>2000-2999</entry>
!                         <entry>a,v,i,d,b</entry>
!                         <entry></entry>
                      </row>
                      <row>
--- 243,304 ----
                      </row>
                      <row>
!                         <entry>2000</entry>
!                         <entry>Incident (SIRIOS-Project)</entry>
!                         <entry>i</entry>
!                         <entry>incident.png</entry>
!                     </row>
!                     <row>
!                         <entry>2100</entry>
!                         <entry>Advisory (SIRIOS-Project)</entry>
!                         <entry>d</entry>
!                         <entry>advisory.png</entry>
!                     </row>
!                     <row>
!                         <entry>2150</entry>
!                         <entry>Advisory (Short)</entry>
!                         <entry>z</entry>
!                         <entry>advisory_short.png</entry>
!                     </row>
!                     <row>
!                         <entry>2300</entry>
!                         <entry>VirusWarning (SIRIOS-BSI-specific)</entry>
!                         <entry>x</entry>
!                         <entry>viruswarning.png</entry>
!                     </row>
!                     <row>
!                         <entry>2400</entry>
!                         <entry>FreeTextMessage (SIRIOS-BSI-specific)</entry>
!                         <entry>y</entry>
!                         <entry>freetextmessage.png</entry>
!                     </row>
!                     <row>
!                         <entry>2500</entry>
!                         <entry>Vulnerability (SIRIOS-Project)</entry>
!                         <entry>v</entry>
!                         <entry>vulnerability.png</entry>
!                     </row>
!                     <row>
!                         <entry>2600</entry>
!                         <entry>Artefact (SIRIOS-Project)</entry>
!                         <entry>r</entry>
!                         <entry>artefactdb.png</entry>
!                     </row>
!                     <row>
!                         <entry>2700</entry>
!                         <entry>WebWatcher (SIRIOS-Project)</entry>
!                         <entry>z</entry>
!                         <entry>webwatcher.png</entry>
!                     </row>
!                     <row>
!                         <entry>2800</entry>
!                         <entry>IDM-Management (SIRIOS-Project)</entry>
!                         <entry>-</entry>
!                         <entry>idmef.png</entry>
!                     </row>
!                     <row>
!                         <entry>7050</entry>
!                         <entry>ContentManager</entry>
!                         <entry>-</entry>
!                         <entry>folder_green.png</entry>
                      </row>
                      <row>
***************
*** 267,270 ****
--- 321,341 ----
                      </row>
                      <row>
+                         <entry>8300</entry>
+                         <entry>FAQ</entry>
+                         <entry>q</entry>
+                         <entry>help.png</entry>
+                     </row>
+                     <row>
+                         <entry>8400</entry>
+                         <entry>Alarm</entry>
+                         <entry>-</entry>
+                         <entry>alarm.png</entry>
+                     </row><row>
+                         <entry>8500</entry>
+                         <entry>Statistic</entry>
+                         <entry>-</entry>
+                         <entry>statistic.png</entry>
+                     </row>
+                     <row>
                          <entry>Admin</entry>
                          <entry>10000</entry>

Index: package-building.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/package-building.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** package-building.xml	10 Aug 2005 14:17:04 -0000	1.2
--- package-building.xml	11 Aug 2005 14:09:58 -0000	1.3
***************
*** 23,27 ****
                      <para>The package name.</para>
                      <programlisting format="linespecific" language="xml">
!                         <Name>Calendar</Name>
                      </programlisting>
                  </listitem>
--- 23,27 ----
                      <para>The package name.</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;Name&gt;Calendar&lt;/Name&gt;
                      </programlisting>
                  </listitem>
***************
*** 30,34 ****
                      <para>The package version.</para>
                      <programlisting format="linespecific" language="xml">
!                         <Version>1.2</Version>
                      </programlisting>
                  </listitem>
--- 30,34 ----
                      <para>The package version.</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;Version&gt;1.2&lt;/Version&gt;
                      </programlisting>
                  </listitem>
***************
*** 37,41 ****
                      <para>The required framework version (2.0.x means e.g. 2.0.1 or 2.0.9).</para>
                      <programlisting format="linespecific" language="xml">
!                         <Framework>2.0.x</Framework>
                      </programlisting>
                  </listitem>
--- 37,41 ----
                      <para>The required framework version (2.0.x means e.g. 2.0.1 or 2.0.9).</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;Framework&gt;2.0.x&lt;/Framework&gt;
                      </programlisting>
                  </listitem>
***************
*** 44,48 ****
                      <para>The package vendor.</para>
                      <programlisting format="linespecific" language="xml">
!                         <Vendor>OTRS GmbH</Vendor>
                      </programlisting>
                  </listitem>
--- 44,48 ----
                      <para>The package vendor.</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;Vendor&gt;OTRS GmbH&lt;/Vendor&gt;
                      </programlisting>
                  </listitem>
***************
*** 51,55 ****
                      <para>The vendor URL.</para>
                      <programlisting format="linespecific" language="xml">
!                         <URL>http://otrs.org/</URL>
                      </programlisting>
                  </listitem>
--- 51,55 ----
                      <para>The vendor URL.</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;URL&gt;http://otrs.org/&lt;/URL&gt;
                      </programlisting>
                  </listitem>
***************
*** 58,62 ****
                      <para>The license of the package.</para>
                      <programlisting format="linespecific" language="xml">
!                         <License>GNU GENERAL PUBLIC LICENSE Version 2, June 1991</License>
                      </programlisting>
                  </listitem>
--- 58,62 ----
                      <para>The license of the package.</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;License&gt;GNU GENERAL PUBLIC LICENSE Version 2, June 1991&lt;/License&gt;
                      </programlisting>
                  </listitem>
***************
*** 65,70 ****
                      <para>The package change log.</para>
                      <programlisting format="linespecific" language="xml">
!                         <ChangeLog>2005-12-02 added change log</ChangeLog>
!                         <ChangeLog>2005-12-02 v1.1 New package</ChangeLog>
                      </programlisting>
                  </listitem>
--- 65,70 ----
                      <para>The package change log.</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;ChangeLog&gt;2005-12-02 added change log&lt;/ChangeLog&gt;
!                         &lt;ChangeLog&gt;2005-12-02 v1.1 New package&lt;/ChangeLog&gt;
                      </programlisting>
                  </listitem>
***************
*** 73,78 ****
                      <para>The package description in different languages.</para>
                      <programlisting format="linespecific" language="xml">
!                         <Description Lang="en">A web calendar.</Description>
!                         <Description Lang="de">Ein Web Kalender.</Description>
                      </programlisting>
                  </listitem>
--- 73,78 ----
                      <para>The package description in different languages.</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;Description Lang="en"&gt;A web calendar.&lt;/Description&gt;
!                         &lt;Description Lang="de"&gt;Ein Web Kalender.&lt;/Description&gt;
                      </programlisting>
                  </listitem>
***************
*** 81,85 ****
                      <para>This will be filled up automatically by OPM.</para>
                      <programlisting format="linespecific" language="xml">
!                         <BuildHost>?</BuildHost>
                      </programlisting>
                  </listitem>
--- 81,85 ----
                      <para>This will be filled up automatically by OPM.</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;BuildHost&gt;?&lt;/BuildHost&gt;
                      </programlisting>
                  </listitem>
***************
*** 88,92 ****
                      <para>This will be filled up automatically by OPM.</para>
                      <programlisting format="linespecific" language="xml">
!                         <BuildDate>?</BuildDate>
                      </programlisting>
                  </listitem>
--- 88,92 ----
                      <para>This will be filled up automatically by OPM.</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;BuildDate&gt;?&lt;/BuildDate&gt;
                      </programlisting>
                  </listitem>
***************
*** 95,100 ****
                      <para>Required modules needs to be installed before.</para>
                      <programlisting format="linespecific" language="xml">
!                         <Required>SomeOtherPackage</Required>
!                         <Required>SomeotherPackage2</Required>
                      </programlisting>
                  </listitem>
--- 95,100 ----
                      <para>Required modules needs to be installed before.</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;Required&gt;SomeOtherPackage&lt;/Required&gt;
!                         &lt;Required&gt;SomeotherPackage2&lt;/Required&gt;
                      </programlisting>
                  </listitem>
***************
*** 103,108 ****
                      <para>Required OS.</para>
                      <programlisting format="linespecific" language="xml">
!                         <OS>Linux</OS>
!                         <OS>MacOS</OS>
                      </programlisting>
                  </listitem>
--- 103,108 ----
                      <para>Required OS.</para>
                      <programlisting format="linespecific" language="xml">
!                         &lt;OS&gt;Linux&lt;/OS&gt;
!                         &lt;OS&gt;MacOS&lt;/OS&gt;
                      </programlisting>
                  </listitem>
***************
*** 115,127 ****
              </para>
              <programlisting format="linespecific" language="xml">
!                 <Filelist>
!                     <File Permission="644" Location="Kernel/Config/Files/Calendar.pm"></File>
!                     <File Permission="644" Location="Kernel/System/CalendarEvent.pm"></File>
!                     <File Permission="644" Location="Kernel/Modules/AgentCalendar.pm"></File>
!                     <File Permission="644" Location="Kernel/Language/de_AgentCalendar.pm"></File>
!                 </Filelist>
              </programlisting>
          </sect2>
!         <sect2 id="database">
              <title>Database</title>
              <para>
--- 115,127 ----
              </para>
              <programlisting format="linespecific" language="xml">
!                 &lt;Filelist&gt;
!                     &lt;File Permission="644" Location="Kernel/Config/Files/Calendar.pm"&gt;&lt;/File&gt;
!                     &lt;File Permission="644" Location="Kernel/System/CalendarEvent.pm"&gt;&lt;/File&gt;
!                     &lt;File Permission="644" Location="Kernel/Modules/AgentCalendar.pm"&gt;&lt;/File&gt;
!                     &lt;File Permission="644" Location="Kernel/Language/de_AgentCalendar.pm"&gt;&lt;/File&gt;
!                 &lt;/Filelist&gt;
              </programlisting>
          </sect2>
!         <sect2 id="database2">
              <title>Database</title>
              <para>
***************
*** 129,143 ****
              </para>
              <programlisting format="linespecific" language="xml">
!                 <DatabaseInstall>
!                     <TableCreate Name="calendar_event">
!                     <Column Name="id" Required="true" PrimaryKey="true" AutoIncrement="true" Type="BIGINT"/>
!                     <Column Name="title" Required="true" Size="250" Type="VARCHAR"/>
!                     <Column Name="content" Required="false" Size="250" Type="VARCHAR"/>
!                     <Column Name="start_time" Required="true" Type="DATE"/>
!                     <Column Name="end_time" Required="true" Type="DATE"/>
!                     <Column Name="owner_id" Required="true" Type="INTEGER"/>
!                     <Column Name="event_status" Required="true" Size="50" Type="VARCHAR"/>
!                     </TableCreate>
!                 </DatabaseInstall>
              </programlisting>
              <para>
--- 129,143 ----
              </para>
              <programlisting format="linespecific" language="xml">
!                 &lt;DatabaseInstall&gt;
!                     &lt;TableCreate Name="calendar_event"&gt;
!                     &lt;Column Name="id" Required="true" PrimaryKey="true" AutoIncrement="true" Type="BIGINT"/&gt;
!                     &lt;Column Name="title" Required="true" Size="250" Type="VARCHAR"/&gt;
!                     &lt;Column Name="content" Required="false" Size="250" Type="VARCHAR"/&gt;
!                     &lt;Column Name="start_time" Required="true" Type="DATE"/&gt;
!                     &lt;Column Name="end_time" Required="true" Type="DATE"/&gt;
!                     &lt;Column Name="owner_id" Required="true" Type="INTEGER"/&gt;
!                     &lt;Column Name="event_status" Required="true" Size="50" Type="VARCHAR"/&gt;
!                     &lt;/TableCreate&gt;
!                 &lt;/DatabaseInstall&gt;
              </programlisting>
              <para>
***************
*** 147,156 ****
              </para>
              <programlisting format="linespecific" language="xml">
!                 <DatabaseUpgrade Version="1.3.4">
!                     <TableCreate Name="calendar_event_involved" Version="1.3.4">
!                         <Column Name="event_id" Required="true" Type="BIGINT"/>
!                         <Column Name="user_id" Required="true" Type="INTEGER"/>
!                     </TableCreate>
!                 </DatabaseUpgrade>
              </programlisting>
              <para>
--- 147,156 ----
              </para>
              <programlisting format="linespecific" language="xml">
!                 &lt;DatabaseUpgrade Version="1.3.4"&gt;
!                     &lt;TableCreate Name="calendar_event_involved" Version="1.3.4"&gt;
!                         &lt;Column Name="event_id" Required="true" Type="BIGINT"/&gt;
!                         &lt;Column Name="user_id" Required="true" Type="INTEGER"/&gt;
!                     &lt;/TableCreate&gt;
!                 &lt;/DatabaseUpgrade&gt;
              </programlisting>
              <para>
***************
*** 158,162 ****
              </para>
              <programlisting format="linespecific" language="xml">
!                 <DatabaseReinstall></DatabaseReinstall>
              </programlisting>
              <para>
--- 158,162 ----
              </para>
              <programlisting format="linespecific" language="xml">
!                 &lt;DatabaseReinstall&gt;&lt;/DatabaseReinstall&gt;
              </programlisting>
              <para>
***************
*** 164,170 ****
              </para>
              <programlisting format="linespecific" language="xml">
!                 <DatabaseUninstall>
!                     <TableDrop Name="calendar_event" />
!                 </DatabaseUninstall>
              </programlisting>
          </sect2>
--- 164,170 ----
              </para>
              <programlisting format="linespecific" language="xml">
!                 &lt;DatabaseUninstall&gt;
!                     &lt;TableDrop Name="calendar_event" /&gt;
!                 &lt;/DatabaseUninstall&gt;
              </programlisting>
          </sect2>
***************
*** 175,217 ****
              </para>
              <programlisting format="linespecific" language="xml">
!                 <?xml version="1.0" encoding="utf-8" ?>
!                 <otrs_package version="1.0">
!                 <Name>Calendar</Name>
!                 <Version>1.2</Version>
!                 <Framework>2.0.x</Framework>
!                 <Vendor>OTRS GmbH</Vendor>
!                 <URL>http://otrs.org/</URL>
!                 <License>GNU GENERAL PUBLIC LICENSE Version 2, June 1991</License>
!                 <ChangeLog>2005-12-02 added change log</ChangeLog>
!                 <ChangeLog>2005-12-02 v1.1 New package</ChangeLog>
!                 <Description Lang="en">A web calendar.</Description>
!                 <Description Lang="de">Ein Web Kalender.</Description>
!                 <BuildDate>?</BuildDate>
!                 <BuildHost>?</BuildHost>
!                 <Filelist>
!                     <File Permission="644" Location="Kernel/Config/Files/Calendar.pm"></File>
!                     <File Permission="644" Location="Kernel/System/CalendarEvent.pm"></File>
!                     <File Permission="644" Location="Kernel/Modules/AgentCalendar.pm"></File>
!                     <File Permission="644" Location="Kernel/Language/de_AgentCalendar.pm"></File>
!                     <File Permission="644" Location="Kernel/Output/HTML/Standard/AgentCalendar.dtl"></File>
!                     <File Permission="644" Location="Kernel/Output/HTML/NotificationCalendar.pm"></File>
!                     <File Permission="644" Location="var/httpd/htdocs/images/Standard/calendar.png"></File>
!                 </Filelist>
!                 <DatabaseInstall>
!                     <TableCreate Name="calendar_event">
!                     <Column Name="id" Required="true" PrimaryKey="true" AutoIncrement="true" Type="BIGINT"/>
!                     <Column Name="title" Required="true" Size="250" Type="VARCHAR"/>
!                     <Column Name="content" Required="false" Size="250" Type="VARCHAR"/>
!                     <Column Name="start_time" Required="true" Type="DATE"/>
!                     <Column Name="end_time" Required="true" Type="DATE"/>
!                     <Column Name="owner_id" Required="true" Type="INTEGER"/>
!                     <Column Name="event_status" Required="true" Size="50" Type="VARCHAR"/>
!                     </TableCreate>
!                 </DatabaseInstall>
!                 <DatabaseReinstall></DatabaseReinstall>
!                 <DatabaseUninstall>
!                     <TableDrop Name="calendar_event"/>
!                 </DatabaseUninstall>
!                 </otrs_package>
              </programlisting>
          </sect2>
--- 175,217 ----
              </para>
              <programlisting format="linespecific" language="xml">
!                 &lt;?xml version="1.0" encoding="utf-8" ?&gt;
!                 &lt;otrs_package version="1.0"&gt;
!                     &lt;Name&gt;Calendar&lt;/Name&gt;
!                     &lt;Version&gt;1.2&lt;/Version&gt;
!                     &lt;Framework&gt;2.0.x&lt;/Framework&gt;
!                     &lt;Vendor&gt;OTRS GmbH&lt;/Vendor&gt;
!                     &lt;URL&gt;http://otrs.org/&lt;/URL&gt;
!                     &lt;License&gt;GNU GENERAL PUBLIC LICENSE Version 2, June 1991&lt;/License&gt;
!                     &lt;ChangeLog&gt;2005-12-02 added change log&lt;/ChangeLog&gt;
!                     &lt;ChangeLog&gt;2005-12-02 v1.1 New package&lt;/ChangeLog&gt;
!                     &lt;Description Lang="en"&gt;A web calendar.&lt;/Description&gt;
!                     &lt;Description Lang="de"&gt;Ein Web Kalender.&lt;/Description&gt;
!                     &lt;BuildDate&gt;?&lt;/BuildDate&gt;
!                     &lt;BuildHost&gt;?&lt;/BuildHost&gt;
!                     &lt;Filelist&gt;
!                         &lt;File Permission="644" Location="Kernel/Config/Files/Calendar.pm"&gt;&lt;/File&gt;
!                         &lt;File Permission="644" Location="Kernel/System/CalendarEvent.pm"&gt;&lt;/File&gt;
!                         &lt;File Permission="644" Location="Kernel/Modules/AgentCalendar.pm"&gt;&lt;/File&gt;
!                         &lt;File Permission="644" Location="Kernel/Language/de_AgentCalendar.pm"&gt;&lt;/File&gt;
!                         &lt;File Permission="644" Location="Kernel/Output/HTML/Standard/AgentCalendar.dtl"&gt;&lt;/File&gt;
!                         &lt;File Permission="644" Location="Kernel/Output/HTML/NotificationCalendar.pm"&gt;&lt;/File&gt;
!                         &lt;File Permission="644" Location="var/httpd/htdocs/images/Standard/calendar.png"&gt;&lt;/File&gt;
!                     &lt;/Filelist&gt;
!                     &lt;DatabaseInstall&gt;
!                         &lt;TableCreate Name="calendar_event"&gt;
!                             &lt;Column Name="id" Required="true" PrimaryKey="true" AutoIncrement="true" Type="BIGINT"/&gt;
!                             &lt;Column Name="title" Required="true" Size="250" Type="VARCHAR"/&gt;
!                             &lt;Column Name="content" Required="false" Size="250" Type="VARCHAR"/&gt;
!                             &lt;Column Name="start_time" Required="true" Type="DATE"/&gt;
!                             &lt;Column Name="end_time" Required="true" Type="DATE"/&gt;
!                             &lt;Column Name="owner_id" Required="true" Type="INTEGER"/&gt;
!                             &lt;Column Name="event_status" Required="true" Size="50" Type="VARCHAR"/&gt;
!                         &lt;/TableCreate&gt;
!                     &lt;/DatabaseInstall&gt;
!                     &lt;DatabaseReinstall&gt;&lt;/DatabaseReinstall&gt;
!                     &lt;DatabaseUninstall&gt;
!                         &lt;TableDrop Name="calendar_event"/&gt;
!                     &lt;/DatabaseUninstall&gt;
!                 &lt;/otrs_package&gt;
              </programlisting>
          </sect2>
***************
*** 220,226 ****
          <title>Package Build</title>
          <screen>
!             shell> bin/opm.pl -a build -p /path/to/example.sopm
              writing .., /tmp/example-1.0.opm
!             shell>
          </screen>
      </sect1>
--- 220,226 ----
          <title>Package Build</title>
          <screen>
!             shell&gt; bin/opm.pl -a build -p /path/to/example.sopm
              writing .., /tmp/example-1.0.opm
!             shell&gt;
          </screen>
      </sect1>

Index: templates.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/templates.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** templates.xml	10 Aug 2005 14:17:04 -0000	1.2
--- templates.xml	11 Aug 2005 14:09:58 -0000	1.3
***************
*** 15,19 ****
          The following descripes the usable dtl tags and syntax.
      </para>
!     <sect1 id="formatting">
          <title>Formatting</title>
          <para>
--- 15,19 ----
          The following descripes the usable dtl tags and syntax.
      </para>
!     <sect1 id="template-formatting">
          <title>Formatting</title>
          <para>
***************
*** 21,51 ****
          </para>
          <programlisting format="linespecific" language="html">
!             <table>
!               <tr>
!                 <td>Key</td>
!                 <td>Value</td>
!               </tr>
!               <tr>
!                 <td>aaa</td>
!                 <td>bbb</td>
!               </tr>
!             </table>
          </programlisting>
          <programlisting format="linespecific" language="html">
!             <form action ="index.pl">
!               <input type="text" value="">
!               <input type="text" value="">
!               <table>
!                 <tr>
!                   <td>Key1</td>
!                   <td>Value1</td>
!                 </tr>
!                 <tr>
!                   <td>Key2</td>
!                   <td>Value2</td>
!                 </tr>
!               </table>
!               <input type="submit">
!             </form>
          </programlisting>
          <sect2 id="Comment">
--- 21,51 ----
          </para>
          <programlisting format="linespecific" language="html">
!             &lt;table&gt;
!               &lt;tr&gt;
!                 &lt;td&gt;Key&lt;/td&gt;
!                 &lt;td&gt;Value&lt;/td&gt;
!               &lt;/tr&gt;
!               &lt;tr&gt;
!                 &lt;td&gt;aaa&lt;/td&gt;
!                 &lt;td&gt;bbb&lt;/td&gt;
!               &lt;/tr&gt;
!             &lt;/table&gt;
          </programlisting>
          <programlisting format="linespecific" language="html">
!             &lt;form action ="index.pl"&gt;
!               &lt;input type="text" value=""&gt;
!               &lt;input type="text" value=""&gt;
!               &lt;table&gt;
!                 &lt;tr&gt;
!                   &lt;td&gt;Key1&lt;/td&gt;
!                   &lt;td&gt;Value1&lt;/td&gt;
!                 &lt;/tr&gt;
!                 &lt;tr&gt;
!                   &lt;td&gt;Key2&lt;/td&gt;
!                   &lt;td&gt;Value2&lt;/td&gt;
!                 &lt;/tr&gt;
!               &lt;/table&gt;
!               &lt;input type="submit"&gt;
!             &lt;/form&gt;
          </programlisting>
          <sect2 id="Comment">
***************
*** 117,121 ****
              </para>
              <programlisting format="linespecific" language="html">
!                 Show no html tags, quote this: $Quote{"<hr><b>some text</b></hr>"}
              </programlisting>
              <para>
--- 117,121 ----
              </para>
              <programlisting format="linespecific" language="html">
!                 Show no html tags, quote this: $Quote{"&lt;hr&gt;&lt;b&gt;some text&lt;/b&gt;&lt;/hr&gt;"}
              </programlisting>
              <para>
***************
*** 125,129 ****
              <programlisting format="linespecific" language="html">
                  Show no html tags, quote this and show just 20 characters:
!                   $Quote{"<hr><b>some text</b></hr>","20"}
              </programlisting>
          </sect2>
--- 125,129 ----
              <programlisting format="linespecific" language="html">
                  Show no html tags, quote this and show just 20 characters:
!                   $Quote{"&lt;hr&gt;&lt;b&gt;some text&lt;/b&gt;&lt;/hr&gt;","20"}
              </programlisting>
          </sect2>
***************
*** 174,183 ****
              </para>
              <programlisting format="linespecific" language="html">
!                 <html>
!                 <head>
!                   <tilte>Some Title</tilte>
                  # include css.dtl file
                  $Include{"css"}
!                 </head>
              </programlisting>
          </sect2>
--- 174,183 ----
              </para>
              <programlisting format="linespecific" language="html">
!                 &lt;html&gt;
!                 &lt;head&gt;
!                   &lt;tilte&gt;Some Title&lt;/tilte&gt;
                  # include css.dtl file
                  $Include{"css"}
!                 &lt;/head&gt;
              </programlisting>
          </sect2>
***************
*** 189,208 ****
              </para>
              <programlisting format="linespecific" language="html">
!                 <table>
!                 <!-- dtl:block:Row -->
!                     <tr>
!                       <td valign="top" width="15%">
!                       <b>
                          $Text{"$Data{"Key"}"}:
!                       </b>
!                       </td>
!                       <td width="85%">
!                       <div title="$QData{"Value"}">
                          $QData{"Value","160"}
!                       </div>
!                       </td>
!                     </tr>
!                 <!-- dtl:block:Row -->
!                 </table>
              </programlisting>
              <para>
--- 189,208 ----
              </para>
              <programlisting format="linespecific" language="html">
!                 &lt;table&gt;
!                 &lt;!-- dtl:block:Row --&gt;
!                     &lt;tr&gt;
!                       &lt;td valign="top" width="15%"&gt;
!                       &lt;b&gt;
                          $Text{"$Data{"Key"}"}:
!                       &lt;/b&gt;
!                       &lt;/td&gt;
!                       &lt;td width="85%"&gt;
!                       &lt;div title="$QData{"Value"}"&gt;
                          $QData{"Value","160"}
!                       &lt;/div&gt;
!                       &lt;/td&gt;
!                     &lt;/tr&gt;
!                 &lt;!-- dtl:block:Row --&gt;
!                 &gt;/table&gt;
              </programlisting>
              <para>
***************
*** 244,248 ****
              </para>
              <programlisting format="linespecific" language="html">
!                 <dtl set $Data{"Test"} = "Some Text">
              </programlisting>
          </sect2>
--- 244,248 ----
              </para>
              <programlisting format="linespecific" language="html">
!                 &lt;dtl set $Data{"Test"} = "Some Text"&gt;
              </programlisting>
          </sect2>
***************
*** 253,257 ****
              </para>
              <programlisting format="linespecific" language="html">
!                 <dtl if ($Text{"Lock"} eq "Lock") { $Data{"Language"} = "en"; }>
              </programlisting>
              <para>
--- 253,257 ----
              </para>
              <programlisting format="linespecific" language="html">
!                 &lt;dtl if ($Text{"Lock"} eq "Lock") { $Data{"Language"} = "en"; }&gt;
              </programlisting>
              <para>
***************
*** 259,263 ****
              </para>
              <programlisting format="linespecific" language="html">
!                 <dtl if ($Text{"Lock"} =~ "/text/i") { $Data{"Lala"} = "Matched"; }>
              </programlisting>
          </sect2>
--- 259,263 ----
              </para>
              <programlisting format="linespecific" language="html">
!                 &lt;dtl if ($Text{"Lock"} =~ "/text/i") { $Data{"Lala"} = "Matched"; }&gt;
              </programlisting>
          </sect2>
***************
*** 269,273 ****
              <programlisting format="linespecific" language="html">
                  # execute system call
!                 <dtl system-call $Data{"uptime"} = "uptime">
                  # print
                  The output of 'uptime' is: $Data{"uptime"}
--- 269,273 ----
              <programlisting format="linespecific" language="html">
                  # execute system call
!                 &lt;dtl system-call $Data{"uptime"} = "uptime"&gt;
                  # print
                  The output of 'uptime' is: $Data{"uptime"}
***************
*** 278,282 ****
              <programlisting format="linespecific" language="html">
                  # execute system call
!                 <dtl system-call $Data{"procinfo"} = "procinfo | head -n1 ">
                  # print
                  The output of 'procinfo' is: $Data{"procinfo"}
--- 278,282 ----
              <programlisting format="linespecific" language="html">
                  # execute system call
!                 &lt;dtl system-call $Data{"procinfo"} = "procinfo | head -n1 "&gt;
                  # print
                  The output of 'procinfo' is: $Data{"procinfo"}
***************
*** 291,295 ****
          <programlisting format="linespecific" language="html">
              # set variable
!             <dtl set $Data{"Test1"} = "English">
  
              # print variable
--- 291,295 ----
          <programlisting format="linespecific" language="html">
              # set variable
!             &lt;dtl set $Data{"Test1"} = "English"&gt;
  
              # print variable
***************
*** 298,302 ****
          <programlisting format="linespecific" language="html">
              # condition
!             <dtl if ($Text{"Lock"} ne "Lock") { $Data{"Test2"} = "Not English!"; }>
  
              # print result
--- 298,302 ----
          <programlisting format="linespecific" language="html">
              # condition
!             &lt;dtl if ($Text{"Lock"} ne "Lock") { $Data{"Test2"} = "Not English!"; }&gt;
  
              # print result

Index: writing-otrs-application.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/writing-otrs-application.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** writing-otrs-application.xml	10 Aug 2005 14:17:04 -0000	1.2
--- writing-otrs-application.xml	11 Aug 2005 14:09:58 -0000	1.3
***************
*** 11,18 ****
          <title>Default Config File</title>
      </sect1>
!     <sect1 id="frontend-module">
          <title>Frontend Module</title>
      </sect1>
!     <sect1 id="core-module">
          <title>Core Module</title>
      </sect1>
--- 11,18 ----
          <title>Default Config File</title>
      </sect1>
!     <sect1 id="writing-frontend-module">
          <title>Frontend Module</title>
      </sect1>
!     <sect1 id="writing-core-module">
          <title>Core Module</title>
      </sect1>



More information about the cvs-log mailing list