Documentation/English (British)/tutorial-tutorial1.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 - Tutorial Documentation - Tutorial 1: Three Page Website with layout</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">Tutorial 1: Three Page Website with layout</span><br><br>\r
  19 \r
  20 This tutorial is to show how Kiriwrite works in a basic form by creating a three page website which all use the same layout.<br><br>\r
  21 \r
  22 To begin, start by going to the location where Kiriwrite is installed and then click on the View Templates menu link. Click on the Add Template sub-menu link and enter the following settings for the new template:<br><br>\r
  23 \r
  24 <table class="infotable">\r
  25     <tr>\r
  26         <td class="tableheading">Setting</td>\r
  27         <td class="tableheading">Value</td>\r
  28     </tr>\r
  29     <tr>\r
  30         <td class="tabledata">Template Name</td>\r
  31         <td class="tabledata">The First Template</td>\r
  32     </tr>\r
  33     <tr>\r
  34         <td class="tabledata">Template Description</td>\r
  35         <td class="tabledata">The First Template for the Kiriwrite tutorial.</td>\r
  36     </tr>\r
  37     <tr>\r
  38         <td class="tabledata">Template Filename</td>\r
  39         <td class="tabledata">firsttemplate.html</td>\r
  40     </tr>\r
  41     <tr>\r
  42         <td class="tabledata">Template Layout</td>\r
  43         <td class="tabledata">&lt;html&gt;<br>\r
  44 &nbsp;&nbsp;&nbsp;&nbsp;&lt;head&gt;<br>\r
  45 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;title&gt;First Website - &lt;kiriwrite:pagetitle&gt;&lt;/title&gt;<br>\r
  46 &nbsp;&nbsp;&nbsp;&nbsp;&lt;/head&gt;<br>\r
  47 &nbsp;&nbsp;&nbsp;&nbsp;&lt;body&gt;<br>\r
  48 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;kiriwrite:pagecontent&gt;<br>\r
  49 &nbsp;&nbsp;&nbsp;&nbsp;&lt;/body&gt;<br>\r
  50 &lt;/html&gt;</td>\r
  51     </tr>\r
  52 </table>\r
  53 \r
  54 <br>\r
  55 \r
  56 After the template settings have been entered, click on the 'Add Template' button. The template should be added to the template database (and the template database created if it doesn't exist).<br><br>\r
  57 \r
  58 Click on the 'View Databases' link and then click on the 'Add Database' button and enter the following settings for the new database:<br><br>\r
  59 \r
  60 <table class="infotable">\r
  61     <tr>\r
  62         <td class="tableheading">Setting</td>\r
  63         <td class="tableheading">Value</td>\r
  64     </tr>\r
  65     <tr>\r
  66         <td class="tabledata">Database Name</td>\r
  67         <td class="tabledata">Tutorial 1</td>\r
  68     </tr>\r
  69     <tr>\r
  70         <td class="tabledata">Database Description</td>\r
  71         <td class="tabledata">The database for Tutorial 1</td>\r
  72     </tr>\r
  73     <tr>\r
  74         <td class="tabledata">Database Categories</td>\r
  75         <td class="tabledata"></td>\r
  76     </tr>\r
  77     <tr>\r
  78         <td class="tabledata">Database Notes</td>\r
  79         <td class="tabledata"></td>\r
  80     </tr>\r
  81     <tr>\r
  82         <td class="tabledata">Database Filename</td>\r
  83         <td class="tabledata">tutorial1</td>\r
  84     </tr>\r
  85 </table>\r
  86 \r
  87 <br>\r
  88 \r
  89 After the database settings have been entered, click on the 'Add Database' button to create a database with the settings given and then click on the 'Return to the database list link'. When the list of databases appears click on the link for the 'Tutorial 1' database and the page list for the database will appear. As there are no pages in the database a message will appear saying that there are no pages in the database.<br><br>\r
  90 \r
  91 Click on the 'Add Page' link the sub-menu and then enter the following information for the new page.<br><br>\r
  92 \r
  93 <table class="infotable">\r
  94     <tr>\r
  95         <td class="tableheading">Setting</td>\r
  96         <td class="tableheading">Value</td>\r
  97     </tr>\r
  98     <tr>\r
  99         <td class="tabledata">Page Name</td>\r
 100         <td class="tabledata">The first page</td>\r
 101     </tr>\r
 102     <tr>\r
 103         <td class="tabledata">Page Description</td>\r
 104         <td class="tabledata">This is the first page.</td>\r
 105     </tr>\r
 106     <tr>\r
 107         <td class="tabledata">Page Section</td>\r
 108         <td class="tabledata">Section</td>\r
 109     </tr>\r
 110     <tr>\r
 111         <td class="tabledata">Page Template</td>\r
 112         <td class="tabledata">The First Template (firsttemplate.html)</td>\r
 113     </tr>\r
 114     <tr>\r
 115         <td class="tabledata">Page Filename</td>\r
 116         <td class="tabledata">firstpage.html</td>\r
 117     </tr>\r
 118     <tr>\r
 119         <td class="tabledata">Page Content</td>\r
 120         <td class="tabledata">This is the content for the first page.</td>\r
 121     </tr>\r
 122     <tr>\r
 123         <td class="tabledata">Page Settings</td>\r
 124         <td class="tabledata">Use page name and section name.</td>\r
 125     </tr>\r
 126 </table>\r
 127 \r
 128 <br>\r
 129 \r
 130 After the page settings have been entered, click on the 'Add Page' button and the page should be added to the Tutorial 1 database. Click on the 'Return to the page list for the 'Tutorial 1' database.' link to return to the page list. Repeat this same process for the next two pages.<br><br>\r
 131 \r
 132 <table class="infotable">\r
 133     <tr>\r
 134         <td class="tableheading">Setting</td>\r
 135         <td class="tableheading">secondpage.html</td>\r
 136         <td class="tableheading">thirdpage.html</td>\r
 137     </tr>\r
 138     <tr>\r
 139         <td class="tabledata">Page Name</td>\r
 140         <td class="tabledata">The second page</td>\r
 141         <td class="tabledata">The third page</td>\r
 142     </tr>\r
 143     <tr>\r
 144         <td class="tabledata">Page Description</td>\r
 145         <td class="tabledata">This is the second page.</td>\r
 146         <td class="tabledata">This is the third page.</td>\r
 147     </tr>\r
 148     <tr>\r
 149         <td class="tabledata">Page Section</td>\r
 150         <td class="tabledata">Section</td>\r
 151         <td class="tabledata">Section</td>\r
 152     </tr>\r
 153     <tr>\r
 154         <td class="tabledata">Page Template</td>\r
 155         <td class="tabledata">The First Template (firsttemplate.html)</td>\r
 156         <td class="tabledata">The First Template (firsttemplate.html)</td>\r
 157     </tr>\r
 158     <tr>\r
 159         <td class="tabledata">Page Filename</td>\r
 160         <td class="tabledata">secondpage.html</td>\r
 161         <td class="tabledata">thirdpage.html</td>\r
 162     </tr>\r
 163     <tr>\r
 164         <td class="tabledata">Page Content</td>\r
 165         <td class="tabledata">This is the content for the second page.</td>\r
 166         <td class="tabledata">This is the content for the third page.</td>\r
 167     </tr>\r
 168     <tr>\r
 169         <td class="tabledata">Page Settings</td>\r
 170         <td class="tabledata">Use page name and section name.</td>\r
 171         <td class="tabledata">Use page name and section name.</td>\r
 172     </tr>\r
 173 </table>\r
 174 \r
 175 <br>\r
 176 \r
 177 Once those two pages have been added, click on the 'Compile Pages' menu link. From the list of available databases to compile, click on the Compile link that to the right of the database with the name 'Tutorial 1'. A confirmation message then asking if it should be compiled and clicking on the 'Compile Database' will compile the pages in that database with the template and put them in the Output Directory.<br><br>\r
 178 \r
 179 Look in the output directory and you will see three files: firstpage.html, secondpage.html and thirdpage.html. Check the source code of each page to see if they've used the same layout but using different content that was specified by each page.\r
 180                 </div>\r
 181         </body>\r
 182 </html>\r