Documentation/English (British)/user-chapter2-templates.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
   2 <html>\r
   3         <head>\r
   4                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
   5                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
   6                 <title>Kiriwrite Documentation - User Documentation - 2.4: Templates</title>\r
   7         </head>\r
   8         <body>\r
   9                 <div class="menubarback">\r
  10                         <div class="menubar">\r
  11                                 <span class="apptitle">Kiriwrite</span>\r
  12                                 <a href="index.html">Index</a> | <a href="user.html">User \r
  13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
  14 <a href="developer.html">Developer Documentation</a>\r
  15                         </div>\r
  16                 </div>\r
  17                 <div class="pageinformation">\r
  18                         <span class="pagetitle">2.4 Templates</span><br><br>\r
  19 \r
  20 Templates allows pages to use a common layout which is used to keep a consistent layout on a website or keep the format of documentation pages the same. Templates also allow small tweaks to the page layout to be made without needing to edit each page so the change is reflected in all of the pages by simply changing the template layout and then recompile the pages.<br><br>\r
  21 \r
  22 The list of templates can be accessed by clicking on the 'View Templates' link. A list of templates from the template database should then appear. If the template database does not exist then a message will appear saying that the template database does not exist and will be created when a template is added. If no templates exist in the template database then a message appears saying that there are no templates in the template database.<br><br>\r
  23 \r
  24 To view the next (or previous list) of templates, click on the relevant link at the top of the page and to view a specific list of templates, select the list page number in the drop down menu box at the top of the page and click on the Show button.<br><br>\r
  25 \r
  26 <span class="heading">2.4.1 Add a template</span><br><br>\r
  27 \r
  28 To add a template to the template database click on the 'Add Template' link from the View Templates sub-menu, a form then appears allowing to enter the new information about the template.<br><br>\r
  29 \r
  30 <table class="infotable">\r
  31     <tr>\r
  32         <td class="tableheading">Setting</td>\r
  33         <td class="tableheading">Description</td>\r
  34     </tr>\r
  35     <tr>\r
  36         <td class="tabledata">Template Name</td>\r
  37         <td class="tabledata">Specifies the template name to be used.</td>\r
  38     </tr>\r
  39     <tr>\r
  40         <td class="tabledata">Template Description</td>\r
  41         <td class="tabledata">Specifies the template description to be used.</td>\r
  42     </tr>\r
  43     <tr>\r
  44         <td class="tabledata">Template Filename</td>\r
  45         <td class="tabledata">Specifies the template filename to use.</td>\r
  46     </tr>\r
  47     <tr>\r
  48         <td class="tabledata">Template Layout</td>\r
  49         <td class="tabledata">Specifies the content of the template layout.</td>\r
  50     </tr>\r
  51 </table>\r
  52 \r
  53 <br>\r
  54 \r
  55 The following Kiriwrite tags can be used with the template layout to automatically place information such as page content, name, description and section:\r
  56 \r
  57 <br><br>\r
  58 \r
  59 <table class="infotable">\r
  60     <tr>\r
  61         <td class="tableheading">Tag</td>\r
  62         <td class="tableheading">Description</td>\r
  63     </tr>\r
  64     <tr>\r
  65         <td class="tabledata">&lt;kiriwrite:pagecontent&gt;</td>\r
  66         <td class="tabledata">Places the page content here.</td>\r
  67     </tr>\r
  68     <tr>\r
  69         <td class="tabledata">&lt;kiriwrite:pagetitle&gt;</td>\r
  70         <td class="tabledata">Places the page title here. The format of the page title can be changed using the Page Settings value.</td>\r
  71     </tr>\r
  72     <tr>\r
  73         <td class="tabledata">&lt;kiriwrite:pagename&gt;</td>\r
  74         <td class="tabledata">Places the page name here.</td>\r
  75     </tr>\r
  76     <tr>\r
  77         <td class="tabledata">&lt;kiriwrite:pagedescription&gt;</td>\r
  78         <td class="tabledata">Places the page description here.</td>\r
  79     </tr>\r
  80     <tr>\r
  81         <td class="tabledata">&lt;kiriwrite:pagesection&gt;</td>\r
  82         <td class="tabledata">Places the page section here.</td>\r
  83     </tr>\r
  84     <tr>\r
  85         <td class="tabledata">&lt;kiriwrite:autosection&gt;</td>\r
  86         <td class="tabledata">Places the automatic page section here.<br><br>\r
  87             <div class="messagebox">\r
  88                 <div class="message note">\r
  89                     <b>Note</b><br>\r
  90                     If there is a page section then the page section will appear bracketed. If Information was the page section then the automatic page section name would be '(Information)' and if the page section name is blank then no brackets will appear and will be blank.\r
  91                 </div>\r
  92             </div> \r
  93         </td>\r
  94     </tr>\r
  95     <tr>\r
  96         <td class="tabledata">&lt;kiriwrite:autotitle&gt;</td>\r
  97         <td class="tabledata">Places the automatic page title here. This combines the section name and page name with brackets around them and a dash separating them with '(Section Name – Page Name)' being the example. The format can be changed by changing the Page Settings value.</td>\r
  98     </tr>\r
  99 </table>\r
 100 \r
 101 <br>\r
 102 \r
 103 After entering the needed template information, click on the 'Add Template' button to display a confirmation message saying that add the template to the list of templates in the template database and offering a link back to the list of templates in the template database. Clicking on the 'Clear values' button will clear all of the template settings entered. Clicking on the 'Return to the template list.' link will return to the list of templates in the template database.<br><br>\r
 104 \r
 105 <span class="heading">2.4.2 Edit a template</span><br><br>\r
 106 To edit a template click on the 'Edit' link opposite the template name you want to edit, a form then appears that is similar to adding a template.<br><br>\r
 107 \r
 108 <table class="infotable">\r
 109     <tr>\r
 110         <td class="tableheading">Setting</td>\r
 111         <td class="tableheading">Description</td>\r
 112     </tr>\r
 113     <tr>\r
 114         <td class="tabledata">Template Name</td>\r
 115         <td class="tabledata">Specifies the new template name to be used.</td>\r
 116     </tr>\r
 117     <tr>\r
 118         <td class="tabledata">Template Description</td>\r
 119         <td class="tabledata">Specifies the new template description to be used.</td>\r
 120     </tr>\r
 121     <tr>\r
 122         <td class="tabledata">Template Filename</td>\r
 123         <td class="tabledata">Specifies the new template filename to use.</td>\r
 124     </tr>\r
 125     <tr>\r
 126         <td class="tabledata">Template Layout</td>\r
 127         <td class="tabledata">Specifies the new content of the template layout.</td>\r
 128     </tr>\r
 129 </table>\r
 130 \r
 131 <br>\r
 132 \r
 133 The Kiriwrite tags used when adding a template can also be used when editing a template.\r
 134 \r
 135 <br><br>\r
 136 \r
 137 <table class="infotable">\r
 138     <tr>\r
 139         <td class="tableheading">Tag</td>\r
 140         <td class="tableheading">Description</td>\r
 141     </tr>\r
 142     <tr>\r
 143         <td class="tabledata">&lt;kiriwrite:pagecontent&gt;</td>\r
 144         <td class="tabledata">Places the page content here.</td>\r
 145     </tr>\r
 146     <tr>\r
 147         <td class="tabledata">&lt;kiriwrite:pagetitle&gt;</td>\r
 148         <td class="tabledata">Places the page title here. The format of the page title can be changed using the Page Settings value.</td>\r
 149     </tr>\r
 150     <tr>\r
 151         <td class="tabledata">&lt;kiriwrite:pagename&gt;</td>\r
 152         <td class="tabledata">Places the page name here.</td>\r
 153     </tr>\r
 154     <tr>\r
 155         <td class="tabledata">&lt;kiriwrite:pagedescription&gt;</td>\r
 156         <td class="tabledata">Places the page description here.</td>\r
 157     </tr>\r
 158     <tr>\r
 159         <td class="tabledata">&lt;kiriwrite:pagesection&gt;</td>\r
 160         <td class="tabledata">Places the page section here.</td>\r
 161     </tr>\r
 162     <tr>\r
 163         <td class="tabledata">&lt;kiriwrite:autosection&gt;</td>\r
 164         <td class="tabledata">Places the automatic page section here.<br><br>\r
 165             <div class="messagebox">\r
 166                 <div class="message note">\r
 167                     <b>Note</b><br>\r
 168                     If there is a page section then the page section will appear bracketed. If Information was the page section then the automatic page section name would be '(Information)' and if the page section name is blank then no brackets will appear and will be blank.\r
 169                 </div>\r
 170             </div> \r
 171         </td>\r
 172     </tr>\r
 173     <tr>\r
 174         <td class="tabledata">&lt;kiriwrite:autotitle&gt;</td>\r
 175         <td class="tabledata">Places the automatic page title here. This combines the section name and page name with brackets around them and a dash separating them with '(Section Name – Page Name)' being the example. The format can be changed by changing the Page Settings value.</td>\r
 176     </tr>\r
 177 </table>\r
 178 \r
 179 <br>\r
 180 \r
 181 After editing the information about the template, the template can be edited by clicking on the 'Edit Template' button which will display a confirmation message saying that the template information was edited offering a link back to the list of templates in the template database. Clicking on the 'Restore current settings' button will undo any changes and revert to the currently used settings. Clicking on the 'Return to the template list.' will return to the list of templates in the template database.<br><br>\r
 182 \r
 183 <span class="heading">2.4.3 Delete a template</span><br><br>\r
 184 \r
 185 To delete a template click on the 'Delete' link opposite the template name you want to delete, a message then appears asking to confirm the deletion of the selected template. Clicking on the 'Yes, delete the template' button will display a confirmation message saying that the selected template has been deleted offering a link back to the list of templates in the template database. Clicking on the 'No, return to the template list.' link will return to the list of templates in the template database.\r
 186                 </div>\r
 187         </body>\r
 188 </html>\r