Documentation/English (British)/user-chapter2-filters.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.3: Filters</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.3 Filters</span><br><br>\r
  19 \r
  20 Filters allows text to be easily replaced by looking for certain words, tag or phrase and then replacing it with another set of words, tag or phrase.<br><br>\r
  21 \r
  22 The list of filters can be viewed by clicking on the 'View Filters' link. If the filter database doesn't exist than a message will appear saying that the filter database doesn't exist and will be created when a filter is added or if the filter database does exist but there are no filters then a message appears saying that there is no filters in the filter database.<br><br>\r
  23 \r
  24 When compiling the pages, the order of the filters list is determined by the filter priority number with the lower numbers being processed first and the filters with the higher filter priority numbers being processed last.<br><br>\r
  25 \r
  26 To view the next (or previous list) of filters, click on the relevant link at the top of the page and to view a specific list of filters, 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
  27 \r
  28 Filters that have a grey background are filters that have been disabled and won't be used when the pages are compiled.<br><br>\r
  29 \r
  30 <span class="heading">2.3.1 Add a filter</span><br><br>\r
  31 \r
  32 To add a filter click on the 'Add Filter' link on the View Filters sub-menu, a form then appears allowing to enter the information about the new filter.<br><br>\r
  33 \r
  34 <table class="infotable">\r
  35     <tr>\r
  36         <td class="tableheading">Setting</td>\r
  37         <td class="tableheading">Description</td>\r
  38     </tr>\r
  39     <tr>\r
  40         <td class="tabledata">Find...</td>\r
  41         <td class="tabledata">Specifies the find setting to search text for.</td>\r
  42     </tr>\r
  43     <tr>\r
  44         <td class="tabledata">Replace With...</td>\r
  45         <td class="tabledata">Specifies the replace setting to replace the text with if the search text is found.</td>\r
  46     </tr>\r
  47     <tr>\r
  48         <td class="tabledata">Priority</td>\r
  49         <td class="tabledata">Specifies the priority of the filter.</td>\r
  50     </tr>\r
  51     <tr>\r
  52         <td class="tabledata">Notes</td>\r
  53         <td class="tabledata">Specifies the notes for this filter.</td>\r
  54     </tr>\r
  55     <tr>\r
  56         <td class="tabledata">Enable this filter</td>\r
  57         <td class="tabledata">Specifies if the filter should be used when the pages are compiled.</td>\r
  58     </tr>\r
  59 </table>\r
  60 \r
  61 <br>\r
  62 \r
  63 After entering the needed filter information, the filter can be added by clicking on the 'Add Filter' button which displays a confirmation message saying that the filter has been added to the filter database and offering a link back to the list of filters in the filter database. Clicking on the 'Clear values' button will clear any of the filter settings that have been entered and clicking on the 'Return to the filter list.' link will return to the list of filters in the filter database.<br><br>\r
  64 \r
  65 <span class="heading">2.3.2 Edit a filter</span><br><br>\r
  66 To edit a filter click on the 'Edit' link opposite the filter you want to edit. A form then appears that is similar to adding a filter.<br><br>\r
  67 \r
  68 <table class="infotable">\r
  69     <tr>\r
  70         <td class="tableheading">Setting</td>\r
  71         <td class="tableheading">Description</td>\r
  72     </tr>\r
  73     <tr>\r
  74         <td class="tabledata">Find...</td>\r
  75         <td class="tabledata">Specifies the new find setting to search text for.</td>\r
  76     </tr>\r
  77     <tr>\r
  78         <td class="tabledata">Replace With...</td>\r
  79         <td class="tabledata">Specifies the new replace setting to replace the text with if the search text is found.</td>\r
  80     </tr>\r
  81     <tr>\r
  82         <td class="tabledata">Priority</td>\r
  83         <td class="tabledata">Specifies the new priority of the filter.</td>\r
  84     </tr>\r
  85     <tr>\r
  86         <td class="tabledata">Notes</td>\r
  87         <td class="tabledata">Specifies the new notes for this filter.</td>\r
  88     </tr>\r
  89     <tr>\r
  90         <td class="tabledata">Enable this filter</td>\r
  91         <td class="tabledata">Specifies if the filter should be used when the pages are compiled.</td>\r
  92     </tr>\r
  93 </table>\r
  94 \r
  95 <br>\r
  96 \r
  97 To update the information about the filter, click on the 'Edit Filter' button and a confirmation message should appear saying that the selected filter was edited offering a link back to the list of filters in the filter database. Clicking on the 'Restore current settings' will undo any changes made and will revert the currently used filter settings and clicking on the 'Return to the filter list.' link will return to the list of filters in the filter database.<br><br>\r
  98 \r
  99 <span class="heading">2.3.3 Delete a filter</span><br><br>\r
 100 \r
 101 To delete a filter click on the 'Delete' link opposite the filter you want to delete. A form then  appears asking to confirm the deletion of the selected filter. Clicking on the 'Yes, delete the selected filter' button will display a confirmation message saying that the selected filter was deleted. Clicking on the 'No, return to the filter list.' link will return to the list of filters in the filter database.\r
 102                 </div>\r
 103         </body>\r
 104 </html>\r