| Textpattern | PHP Cross Reference | Content Management Systems |
1 <?xml version="1.0" encoding="utf-8"?> 2 <resources> 3 <help lang="en-US"> 4 <group id="admin" title="Users panel"> 5 <item id="about_privileges" title="About roles"><![CDATA[ 6 <h2>About roles</h2> 7 <h3>Publisher</h3> 8 <ul> 9 <li>can manage articles, comments and links</li> 10 <li>can use PHP in articles if admin preference ‘Allow PHP in articles?’ is set to ‘Yes’</li> 11 <li>can manage images and files</li> 12 <li>can manage sections and categories</li> 13 <li>can manage pages, forms and style</li> 14 <li>can view diagnostic information</li> 15 <li>can manage site preferences</li> 16 <li>can manage users</li> 17 <li>can manage visitor logs</li> 18 <li>can manage plugins</li> 19 <li>can import data</li> 20 </ul> 21 <h3>Managing Editor</h3> 22 <ul> 23 <li>can manage articles, comments and links</li> 24 <li>can use PHP in articles if admin preference ‘Allow PHP in articles?’ is set to ‘Yes’</li> 25 <li>can manage images and files</li> 26 <li>can manage sections and categories</li> 27 <li>can manage pages, forms and style</li> 28 <li>can view diagnostic information</li> 29 <li>can manage site preferences</li> 30 <li>can view users</li> 31 <li>can manage visitor logs</li> 32 <li>can manage plugins</li> 33 <li>can import data</li> 34 </ul> 35 <h3>Copy Editor</h3> 36 <ul> 37 <li>can manage articles with one limitation: 38 <ul> 39 <li>cannot delete those belonging to other users</li> 40 </ul> 41 </li> 42 <li>can manage comments and links</li> 43 <li>can manage images and files</li> 44 <li>can manage categories</li> 45 <li>can manage pages and forms</li> 46 <li>can view users</li> 47 <li>can manage visitor logs</li> 48 </ul> 49 <h3>Staff Writer</h3> 50 <ul> 51 <li>can manage own articles, view other users’ articles</li> 52 <li>can manage images and files</li> 53 </ul> 54 <h3>Freelancer</h3> 55 <ul> 56 <li>can manage own articles in a limited sense: 57 <ul> 58 <li>can only modify article until is published</li> 59 <li>can apply status of <em>only</em> Draft, Hidden or Pending</li> 60 </ul> 61 </li> 62 <li>can view other users’ articles</li> 63 </ul> 64 <h3>Designer</h3> 65 <ul> 66 <li>can manage own articles in a limited sense: 67 <ul> 68 <li>can only modify article until is published</li> 69 <li>can apply status of <em>only</em> Draft, Hidden or Pending</li> 70 </ul> 71 </li> 72 <li>can view other users’ articles</li> 73 <li>can manage images</li> 74 <li>can manage sections</li> 75 <li>can manage pages, forms and style</li> 76 </ul> 77 ]]></item> 78 <item id="create_author" title="Create author"><![CDATA[ 79 <h2>Add new author</h2> 80 <p>A password, welcome message and login instructions will be emailed to the new author.</p> 81 ]]></item> 82 </group> 83 84 <group id="article" title="Write panel"> 85 <item id="article_image" title="Article image"><![CDATA[ 86 <h2>Article image</h2> 87 <p>To associate a single image with this article, place one of the following here:</p> 88 <ol> 89 <li>a Textpattern image ID (e.g. <code>12</code>)</li> 90 <li>a relative URL to the image (e.g. <code>/images/my_pic.jpg</code>)</li> 91 <li>a fully-qualified URL (e.g. <code>https://example.com/path/to/images/my_pic.jpg</code>)</li> 92 </ol> 93 <p>The image can be displayed by placing a <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/article_image"><code><txp:article_image /></code> tag <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> inside an article form. It will output a complete HTML <code><img></code> tag to the chosen image.</p> 94 ]]></item> 95 <item id="body" title="Body"><![CDATA[ 96 <h2>Body</h2> 97 <p>The main content of an article is contained within the article body.</p> 98 <p>When composing or preparing articles for publication in Textpattern, an author can switch between three views of the article: plain text, HTML markup (the code with which a web browser renders the article), and a rendered preview.</p> 99 ]]></item> 100 <item id="description" title="Description"><![CDATA[ 101 <h2>Description</h2> 102 <p>The article description is an optional component that can help search engines and website crawlers better identify and sort content.</p> 103 <p>The article description is limited to a maximum of 255 characters. Note that some search engines place character limits on the length of a page’s <code>meta description</code> for practicality of display in search engine results pages (SERPs) and this may be less than the 255 character limit in Textpattern.</p> 104 <p>Note that the article description differs from the article excerpt, though they both accept similar content. The article description should be primarily intended for use with search engines and crawlers, whereas the the article excerpt is more suited for a human-readable article summary where desired.</p> 105 ]]></item> 106 <item id="excerpt" title="Excerpt"><![CDATA[ 107 <h2>Excerpt</h2> 108 <p>Article excerpts are optional. Excerpts could be used as a short summary of the article that is displayed as part of a table of contents, used in place of the full article body in the site’s RSS/Atom feeds, or a number of other uses.</p> 109 ]]></item> 110 <item id="expire_date" title="Expiration date"><![CDATA[ 111 <h2>Expiration date</h2> 112 <p>The time an article is labelled as expired. The time is optional and can be set to an arbitrary time in the past or future.</p> 113 <p>The boxes correspond to the following information:</p> 114 <ul> 115 <li>Year / Month / Day</li> 116 <li>Hour (24-hour format) : Minute : Second</li> 117 </ul> 118 <p>When the time arrives, or in the case where a time in the past is provided, the article expires.</p> 119 <p>If the option to display expired articles is enabled, the article remains visible. If the option to display expired articles is disabled, visitors to the article page will be served an HTTP 410 error in place of the article content.</p> 120 ]]></item> 121 <item id="keywords" title="Keywords"><![CDATA[ 122 <h2>Keywords</h2> 123 <p>Keywords are useful for refining the relationships between articles beyond those provided by categories.</p> 124 <p>Keywords must be individual words separated by commas.</p> 125 ]]></item> 126 <item id="override_form" title="Override form"><![CDATA[ 127 <h2>Override form</h2> 128 <p>An article can optionally use a form different from that assigned by default - for example to show an article excerpt with <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/excerpt"><code><txp:excerpt /></code> <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> instead of the article body with <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/body"><code><txp:body /></code> <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> - this can be set here.</p> 129 ]]></item> 130 <item id="publish_date" title="Publish date"><![CDATA[ 131 <h2>Publish date</h2> 132 <p>The time an article or file is published or most-recently revised. The time can be set to the moment the item is published, or to an arbitrary time in the past or future.</p> 133 <p>The boxes correspond to the following information:</p> 134 <ul> 135 <li>Year / Month / Day</li> 136 <li>Hour (24-hour format) : Minute : Second</li> 137 </ul> 138 <p>An item with a timestamp greater than the current time (i.e. in the future) will not appear on the front side and the RSS/Atom feeds until that time arrives.</p> 139 ]]></item> 140 <item id="status" title="Status"><![CDATA[ 141 <h2>Status</h2> 142 <p>Defines the publishing visibility status of this Textpattern article.</p> 143 <p>The publishing status is one of the following:</p> 144 <ul> 145 <li>Draft</li> 146 <li>Hidden</li> 147 <li>Pending</li> 148 <li>Live</li> 149 <li>Sticky</li> 150 </ul> 151 <p>A <strong>draft</strong> article is considered a work-in-progress and is not viewable outside of the Textpattern administration area (i.e. not visible on the Textpattern front side and not syndicated in feeds).</p> 152 <p>A <strong>hidden</strong> article is not viewable outside of the Textpattern administration area.</p> 153 <p>A <strong>pending</strong> article is considered ready for publication and awaiting approval, but is not viewable outside of the Textpattern administration area.</p> 154 <p>A <strong>live</strong> article is typically viewable outside the Textpattern administration area (i.e. visible on the Textpattern front side, syndicated in feeds if the preference permits). If an article is live and has an expiration date, the status will remain as live after that date has been reached, but the article only appears outside the administration area if expired articles are permitted to be published.</p> 155 <p>A <strong>sticky</strong> article is similar to a <strong>live</strong> article insofar as it can be viewed outside the Textpattern administration area but will <strong>not</strong> appear in article lists unless the respective <code>article</code> or <code>article_custom</code> tag includes a <code>status</code> attribute with a <code>sticky</code> value.</p> 156 ]]></item> 157 <item id="title" title="Title"><![CDATA[ 158 <h2>Title</h2> 159 <p>Add an appropriate title for this article.</p> 160 <p>An article title is limited to a maximum of 255 characters.</p> 161 ]]></item> 162 <item id="url_title" title="URL-only title"><![CDATA[ 163 <h2>URL-only title</h2> 164 <p>To use a specific title in to the permalink URL for an article, enter it here. If it is left blank, the URL title will be automatically generated from the article title.</p> 165 <p>This is particularly useful if the title of the article uses non-ASCII characters.</p> 166 ]]></item> 167 </group> 168 169 <group id="category" title="Categories panel"> 170 <item id="article_category" title="Articles"><![CDATA[ 171 <h2>Articles</h2> 172 <p>Unlike sections, which define the navigational structure of a site, article categories allow organization of articles by their subject matter. Once categories are assigned, lists of articles belonging to particular categories can be browsed.</p> 173 <p>For example, likely article categories on a site about food might be:</p> 174 <ul> 175 <li>raw ingredients</li> 176 <li>shopping</li> 177 <li>recipes</li> 178 <li>presentation</li> 179 <li>restaurants</li> 180 <li>chefs</li> 181 </ul> 182 ]]></item> 183 <item id="category_description" title="Description"><![CDATA[ 184 <h2>Category description</h2> 185 <p>The category description is an optional component that can help search engines and website crawlers better identify and sort content.</p> 186 <p>The category description is limited to a maximum of 255 characters. Note that some search engines place character limits on the length of a page’s <code>meta description</code> for practicality of display in search engine results pages (SERPs) and this may be less than the 255 character limit in Textpattern.</p> 187 ]]></item> 188 <item id="file_category" title="Files"><![CDATA[ 189 <h2>Files</h2> 190 <p>File categories are optional, and useful for grouping selected uploaded files together.</p> 191 ]]></item> 192 <item id="image_category" title="Images"><![CDATA[ 193 <h2>Images</h2> 194 <p>Image categories are optional, and useful both for internal organization and for defining image sets that can be displayed using the <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/image_index"><code><txp:image_index /></code> <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> and <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/image_display"><code><txp:image_display /></code> <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> tags.</p> 195 ]]></item> 196 <item id="link_category" title="Links"><![CDATA[ 197 <h2>Links</h2> 198 <p>Link categories are optional, and are useful for displaying different groupings of links, e.g. ‘Friends’, ‘Romans’, ‘Countrymen’.</p> 199 <p>Selective link lists such as these are output with the <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/linklist"><code><txp:linklist /></code> tag <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> like so:</p> 200 <pre><code><code><txp:linklist category="Friends" /></code>.</code></pre> 201 ]]></item> 202 </group> 203 204 <group id="diag" title="Diagnostics panel"> 205 <item id="clean_url_data_failed" title="Clean URL data failed"><![CDATA[ 206 <h2>Clean URL data failed</h2> 207 <p>It appears that either the site URLs (e.g. <code>https://example.com/section/article</code>) are currently not working or the web server does not support the test procedure to determine if clean URLs work or not; if clean URLs on the site work as expected, this message can be safely ignored.</p> 208 <p>If clean URLs are <em>not</em> working it may mean either:</p> 209 <ul> 210 <li>the ‘Site URL’ setting is incorrect, or the page at that address is not managed by this instance of Textpattern</li> 211 <li>the server requires some changes to <code>.htaccess</code> or similar server directive in order to make clean URLs work</li> 212 <li>the server doesn’t support clean URLs at all</li> 213 </ul> 214 <p>The clean URL test attempts to fetch a page from the web address specified in the ‘Site URL’ preference in order to check that all clean URL parameters are working correctly. If that URL is a different site, or has been replaced with a static page or similar, the test will fail. Until the issue is resolved messy URLs (e.g. <code>https://example.com?s=section&id=4</code>) should be used. Ensure the ‘Permanent link mode’ in Admin Preferences is set accordingly.</p> 215 <p>Note that using a plugin to put a site in ‘maintenance mode’ may trigger this warning.</p> 216 ]]></item> 217 <item id="clean_url_test_failed" title="Clean URL test failed"><![CDATA[ 218 <h2>Clean URL test failed</h2> 219 <p>It appears that either the site URLs (e.g. <code>https://example.com/section/article</code>) are currently not working or the web server does not support the test procedure to determine if clean URLs work or not; if clean URLs on the site work as expected, this message can be safely ignored.</p> 220 <p>If clean URLs are <em>not</em> working it may mean either:</p> 221 <ul> 222 <li>the ‘Site URL’ setting is incorrect, or the page at that address is not managed by this instance of Textpattern</li> 223 <li>the server requires some changes to <code>.htaccess</code> or similar server directive in order to make clean URLs work</li> 224 <li>the server doesn’t support clean URLs at all</li> 225 </ul> 226 <p>The clean URL test attempts to fetch a page from the web address specified in the ‘Site URL’ preference in order to check that all clean URL parameters are working correctly. If that URL is a different site, or has been replaced with a static page or similar, the test will fail. Until the issue is resolved messy URLs (e.g. <code>https://example.com?s=section&id=4</code>) should be used. Ensure the ‘Permanent link mode’ in Admin Preferences is set accordingly.</p> 227 ]]></item> 228 <item id="diag_clear_private" title="Hide private information"><![CDATA[ 229 <h2>Hide private information</h2> 230 <p>Hide private information for extra security. If diagnostic information is to be shared in a publicly-viewable format, for example the Textpattern support forum, this reduces a security risk by omitting sensitive server information.</p> 231 ]]></item> 232 <item id="dev_version_live" title="Development code on a live server"><![CDATA[ 233 <h2>Development code on a live server</h2> 234 <p>In-development versions of Textpattern are not recommended for use on production sites. This warning can be safely ignored if the risks are understood and acceptable.</p> 235 ]]></item> 236 <item id="dir_not_writable" title="Directory is not writable"><![CDATA[ 237 <h2>Directory is not writable</h2> 238 <p>To use the file and image upload capabilities, these directories must be writable by PHP via the web server user. This can be done with an (S)FTP client, or alternatively on the command line by issuing a <code>chmod 755 /path/to/dir</code> command.</p> 239 ]]></item> 240 <item id="dns_lookup_fails" title="DNS fails"><![CDATA[ 241 <h2>DNS lookup failed</h2> 242 <p>It appears the URL specified as the address of the site is unreachable.</p> 243 ]]></item> 244 <item id="file_uploads_disabled" title="File uploads are disabled"><![CDATA[ 245 <h2>File uploads are disabled</h2> 246 <p>The current server configuration indicates that file uploads are disabled. Please check and alter the <code>file_uploads</code> setting in <code>php.ini</code> or consult the site host for assistance.</p> 247 ]]></item> 248 <item id="htaccess_missing" title=".htaccess file missing"><![CDATA[ 249 <h2>.htaccess file missing</h2> 250 <p>A permanent link mode which requires an <code>.htaccess</code> file is being used, and the file cannot be found. The file is included with Textpattern and resides in the Textpattern root, alongside <code>index.php</code> and the <code>textpattern</code> directory. The recommended directives are:</p> 251 <pre><code># BEGIN Textpattern 252 #DirectoryIndex index.php index.html 253 254 #Options +FollowSymLinks 255 #Options -Indexes 256 #ErrorDocument 403 default 257 258 <IfModule mod_rewrite.c> 259 RewriteEngine On 260 #RewriteBase /relative/web/path/ 261 262 RewriteCond %{REQUEST_FILENAME} -f [OR] 263 RewriteCond %{REQUEST_FILENAME} -d 264 RewriteRule ^(.+) - [PT,L] 265 266 RewriteCond %{REQUEST_URI} !=/favicon.ico 267 RewriteRule ^(.*) index.php 268 269 RewriteCond %{HTTP:Authorization} !^$ 270 RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization}] 271 </IfModule> 272 273 <IfModule mod_mime.c> 274 AddType image/svg+xml svg svgz 275 AddEncoding gzip svgz 276 </IfModule> 277 # END Textpattern</code></pre> 278 ]]></item> 279 <item id="index_inaccessible" title="Site index inaccessible"><![CDATA[ 280 <h2>Site index inaccessible</h2> 281 <p>The root <code>index.php</code> file specified as the index for the site is unreadable by the server. Please check its existence and permissions.</p> 282 ]]></item> 283 <item id="missing_files" title="Missing files"><![CDATA[ 284 <h2>Missing files</h2> 285 <p>One or more essential files are missing from Textpattern. Ensure that all the listed files are present on the server and are in the correct locations.</p> 286 ]]></item> 287 <item id="mod_rewrite_missing" title="Apache mod_rewrite missing"><![CDATA[ 288 <h2>Apache mod_rewrite missing</h2> 289 <p>Apache’s <code>mod_rewrite</code> module is not installed or disabled. This is recommended for Textpattern to function correctly. Ensure its existence and activated state, or contact the site‘s host for assistance.</p> 290 ]]></item> 291 <item id="modified_files" title="Modified files"><![CDATA[ 292 <h2>Modified files</h2> 293 <p>Files are determined to be modified if their respective checksum differs from the known-good checksum list provided with Textpattern. If any files in the Textpattern installation are different to those expected, the files will be highlighted here.</p> 294 ]]></item> 295 <item id="mysql_table_errors" title="MySQL table errors"><![CDATA[ 296 <h2>MySQL table errors</h2> 297 <p>There may be some corruption or damage in Textpattern‘s MySQL database. Try repairing the affected table(s) with a MySQL access tool, such as <a rel="external" target="_blank" href="https://www.adminer.org">Adminer <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> or <a rel="external" target="_blank" href="https://www.phpmyadmin.net">phpMyAdmin <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a>.</p> 298 ]]></item> 299 <item id="no_temp_dir" title="No temporary directory defined"><![CDATA[ 300 <h2>No temporary directory defined</h2> 301 <p>While Textpattern will run without a temporary directory, some functionality may not work as expected if this preference is not set. Please visit Admin Preferences and set up the ‘Temporary directory path’.</p> 302 ]]></item> 303 <item id="old_placeholder_exists" title="Section directory exists"><![CDATA[ 304 <h2>Section directory exists</h2> 305 <p>Existing section directory files will conflict with the the <code>.htaccess</code> scheme. If the reported files are placeholders, please delete them.</p> 306 ]]></item> 307 <item id="path_to_site_inaccessible" title="Site directory unreadable"><![CDATA[ 308 <h2>Site directory unreadable</h2> 309 <p>The directory containing the root <code>index.php</code> file specified as the index for the site is unreadable by the server. Please check permissions.</p> 310 ]]></item> 311 <item id="php_version_required" title="Minimum version requirements"><![CDATA[ 312 <h2>Minimum version requirements</h2> 313 <p>Textpattern requires certain functionality present in the PHP programming language and MySQL database server. Please consult the following table to determine the minimum system requirements:</p> 314 <div class="txp-listtables"> 315 <table class="txp-list"> 316 <thead> 317 <tr> 318 <th scope="col">Textpattern version</th> 319 <th scope="col">Minimum PHP version</th> 320 <th scope="col">Minimum MySQL version</th> 321 </tr> 322 </thead> 323 <tbody> 324 <tr> 325 <th scope="row">4.7.x</th> 326 <td>5.4.0</td> 327 <td>5.0.3</td> 328 </tr> 329 <tr> 330 <th scope="row">4.6.x</th> 331 <td>5.3.3</td> 332 <td>4.1</td> 333 </tr> 334 <tr> 335 <th scope="row">4.5.x</th> 336 <td>5.2.3</td> 337 <td>4.1</td> 338 </tr> 339 <tr> 340 <th scope="row">4.0.1 - 4.4.1</th> 341 <td>4.3</td> 342 <td>3.23</td> 343 </tr> 344 </tbody> 345 </table> 346 </div> 347 <p>In addition to the above system requirements, the following PHP extensions are required:</p> 348 <ul> 349 <li><a rel="external" target="_blank" href="https://www.php.net/manual/en/book.mysqli.php">mysqli <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a></li> 350 <li><a rel="external" target="_blank" href="https://www.php.net/manual/en/book.xml.php">XML <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a></li> 351 <li><a rel="external" target="_blank" href="https://www.php.net/manual/en/book.json.php">JSON <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a></li> 352 </ul> 353 <p>The site‘s <code>php.ini</code> file, either global or local, needs to contain a <code>date.timezone</code> setting.</p> 354 ]]></item> 355 <item id="setup_still_exists" title="Setup directory still exists"><![CDATA[ 356 <h2>Setup directory still exists</h2> 357 <p>When Textpattern has been installed, the <code>textpattern/setup</code> directory and its contents are no longer needed, and should be deleted for security reasons.</p> 358 ]]></item> 359 <item id="site_url_mismatch" title="Site URL mismatch"><![CDATA[ 360 <h2>Site URL mismatch</h2> 361 <p>The Site URL as set in the ‘Preferences’ panel does not match the actual URL used to visit the site.</p> 362 <p>If the site can be reached through multiple different URLs, and if the site behaves as expected, this messaged can be safely ignored.</p> 363 <p>Otherwise, please check and amend the ‘Site URL’ setting in Admin Preferences as required. An educated guess of the correct Site URL is shown in the pre-flight warning message on the ‘Diagnostics’ panel.</p> 364 ]]></item> 365 <item id="some_php_functions_disabled" title="PHP functions […] are disabled on your server"><![CDATA[ 366 <h2>PHP functions […] are disabled on your server</h2> 367 <p>The site host or server administrator has disabled one or more PHP functions, some of which may affect the running of Textpattern.</p> 368 <p>Please consult the <a rel="external" target="_blank" href="https://docs.textpattern.com/administration/diagnostics-panel#diagnostic-reporting-on-php-functions">Textpattern User Documentation <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> for further information.</p> 369 ]]></item> 370 <item id="textpattern_version_update" title="Textpattern version update"><![CDATA[ 371 <h2>Textpattern version update</h2> 372 <p>There is a newer version of Textpattern available. To take advantage of the latest features and security, it is recommended you upgrade.</p> 373 <p>Please note that while we strive to make the upgrade experience as seamless and pain-free as possible:</p> 374 <ul> 375 <li>If only the last digit differs from your current version, the upgrade is likely to be backwards compatible with plugins and themes.</li> 376 <li>If the last two digits differ from your current version, the upgrade might require updates to some plugins and/or themes, although it will probably continue to work anyway in a limited capacity.</li> 377 <li>If the first digit is different from your current version, the upgrade is likely to require updates to most plugins and themes. If you rely heavily on a particular plugin or theme feature, please check with the author or community members before commencing the upgrade.</li> 378 </ul> 379 ]]></item> 380 <item id="textpattern_version_update_beta" title="Textpattern pre-release available"><![CDATA[ 381 <h2>Textpattern pre-release update available</h2> 382 <p>There is a newer pre-release version of Textpattern available. We are looking for active volunteers to test this version so we can make the final release as solid as possible. We strive to make the upgrade experience seamless and pain-free, even for beta code.</p> 383 <p>Should you decide to participate, please note:</p> 384 <ul> 385 <li>Do not use this beta release on a production site unless you have a working backup of both the site's files and its database, and know how to use it.</li> 386 <li>Please <a href="https://github.com/textpattern/textpattern/issues">report any issues</a>, stating the beta version that you are using. Further beta releases may be required prior to the stable release, depending on issues reported.</li> 387 <li>Ensure that if you deploy this beta release, you also update to the final version when it is released.</li> 388 </ul> 389 ]]></item> 390 <item id="tmp_plugin_paths_match" title="Temporary and Plugin cache directory paths should not match"><![CDATA[ 391 <h2>Temporary and Plugin cache directory paths should not match</h2> 392 <p>Plugins should have their own directory and not share the temporary directory. This is a potential security risk and may adversely affect your site if the temporary directory is flushed. Please ensure that the temporary directory path is different to the plugin cache path.</p> 393 ]]></item> 394 <item id="update_server_inaccessible" title="Update server inaccessible"><![CDATA[ 395 <h2>Update server inaccessible</h2> 396 <p>The check for updates failed, often due to network congestion or a connection timeout. This situation usually resolves itself within an hour or two so try revisiting this panel later.</p> 397 ]]></item> 398 <item id="warn_mail_unavailable" title="Your PHP installation is missing the mail() function"><![CDATA[ 399 <h2>Your PHP installation is missing the mail() function</h2> 400 <p>PHP’s <a rel="external" target="_blank" href="https://www.php.net/manual/en/function.mail.php">mail <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> function is disabled. Therefore, Textpattern cannot send emails and some functionality will not be available. For example, email notifications for new comments will not be sent, and new users will not receive a welcome email. Users can still be added, however.</p> 401 ]]></item> 402 </group> 403 404 <group id="file" title="Files panel"> 405 <item id="file_reassign" title="Reassign file"><![CDATA[ 406 <h2>Reassign file</h2> 407 <p>When you upload a file in place of one that is labelled ‘Missing’, your chosen file is uploaded to the server and linked to the original file information in the database. This means the file name of the original file will remain, as will all other associated information such as download count and category. The file size will, however, be updated to reflect the new file.</p> 408 ]]></item> 409 <item id="file_replace" title="Replace file"><![CDATA[ 410 <h2>Replace file</h2> 411 <p>Uploading a file here will replace the contents of the existing file on the server but will keep the file name the same as it was before. The download count and other information associated with the file remain unaffected.</p> 412 ]]></item> 413 <item id="timestamp_file" title="Publish date"><![CDATA[ 414 <h2>Write: Publish date</h2> 415 <p>The time a file is published or most-recently revised. The time can be set to the moment the item is published, or to an arbitrary time in the past or future.</p> 416 <p>The boxes correspond to the following information:</p> 417 <ul> 418 <li>Year / Month / Day</li> 419 <li>Hour (24-hour format) : Minute : Second</li> 420 </ul> ]]></item> 421 <item id="upload" title="Upload file"><![CDATA[ 422 <h2>Upload file</h2> 423 <p>Use this form to upload files or images to your server.</p> 424 <p>Use the Textile code to render graphics within articles, the Textpattern code to place graphics on your page templates, or HTML code to place the graphics elsewhere.</p> 425 ]]></item> 426 </group> 427 428 <group id="form" title="Forms panel"> 429 <item id="forms_overview" title="Introduction to Forms"><![CDATA[ 430 <h2>Introduction to Forms</h2> 431 <p>In Textpattern, a form is a snippet or chunk of text, HTML, and Textpattern tags that can be reused to display content.</p> 432 <p>Here’s an example form which could be named <code>ordinary_list</code>:</p> 433 <pre><code><li> 434 <txp:permlink> 435 <txp:title /> 436 </txp:permlink> 437 </li></code></pre> 438 <p>You could use it to display an HTML unordered list of related articles:</p> 439 <pre><code><txp:related_articles form="ordinary_list" wraptag="ul" /></code></pre> 440 <p>Since the role of this form is to output a list of titles, it could be applicable inside other tags, such as showing 20 articles from the current section:</p> 441 <pre><code><txp:article form="ordinary_list" limit="20" wraptag="ol" /></code></pre> 442 <p>You may also choose to employ a form to display repeated content, such as header and footer in your page templates. This means the content only exists in one place and if you decide to change it, you only need to do it once. Displaying content from a form is usually accomplished with:</p> 443 <pre><code><txp:output_form form="your_form_name" /></code></pre> 444 <p>A form can be up to 64KB in size. An example for a footer might include headings, paragraphs, links, conditional tags, and references to other forms such as <code>ordinary_list</code>.</p> 445 ]]></item> 446 </group> 447 448 <group id="image" title="Images panel"> 449 <item id="create_thumbnail" title="Create thumbnail"><![CDATA[ 450 <h2>Create thumbnail</h2> 451 <p>Allows you to (re)create a thumbnail of the specified dimensions from the full size image.</p> 452 <p>The thumbnail will be scaled to fit the dimensions you choose, unless you select the ‘Crop’ checkbox. In that case, the thumbnail will be created from the centre of the image without any scaling.</p> 453 ]]></item> 454 <item id="replace_image_form" title="Replace image"><![CDATA[ 455 <h2>Replace image</h2> 456 <p>An image uploaded here will simply replace the existing one associated with this entry in the database.</p> 457 ]]></item> 458 <item id="upload_image" title="Upload image"><![CDATA[ 459 <h2>Upload image</h2> 460 <p>Upload one or more images to your server.</p> 461 <p>Upon upload to the <code>images</code> directory, the filename of your original image will be kept only internally in Textpattern’s database; the image file itself will be renamed to a sequential number + file extension.</p> 462 ]]></item> 463 <item id="upload_thumbnail" title="Upload thumbnail"><![CDATA[ 464 <h2>Upload thumbnail</h2> 465 <p>Full size images can be assigned their own thumbnails. These are useful for linking to - and the indexing of - full size images.</p> 466 <p>A reference to the thumbnail is exactly the same as the reference to the full size image, with <code>t</code> appended to the file name. For example, to reference a thumbnail associated with a full size image stored at <code>/images/12.jpg</code> you would use <code>/images/12t.jpg</code>.</p> 467 ]]></item> 468 </group> 469 470 <group id="lang" title="Languages panel"> 471 <item id="get_textpack" title="Install Textpack"><![CDATA[ 472 <h2>Install Textpack</h2> 473 <p>Paste additional language strings for your site into this box and select ‘Upload’ to install them.</p> 474 <p>The strings will often come in the form of a downloadable Textpack, distributed with a plugin to permit the plugin’s language strings to be used natively within Textpattern.</p> 475 <p>Translators may then translate these packs as necessary and redistribute the localized content to the community.</p> 476 ]]></item> 477 </group> 478 479 <group id="link" title="Links panel"> 480 <item id="link_description" title="Description"><![CDATA[ 481 <h2>Description</h2> 482 <p>Descriptions for links are optional, and are useful for captioning links, for creating <code>title=""</code> (tooltip) attributes for links, or simply keeping your own internal documentation.</p> 483 ]]></item> 484 <item id="link_sort" title="Sort value"><![CDATA[ 485 <h2>Sort value</h2> 486 <p>Useful for natural-language sorting of link lists, e.g. on a person’s last name rather than their first, or on phrases that begin with a definite or indefinite article.</p> 487 ]]></item> 488 <item id="link_url" title="URL"><![CDATA[ 489 <h2>URL</h2> 490 <p>The address of the link. If the link points to a different site, then it must be preceded by <code>http://</code> or <code>https://</code>.</p> 491 ]]></item> 492 <item id="timestamp_link" title="Publish date"><![CDATA[ 493 <h2>Publish date</h2> 494 <p>The time a link is published or most-recently revised. The time can be set to the moment the item is published, or to an arbitrary time in the past or future.</p> 495 <p>The boxes correspond to the following information:</p> 496 <ul> 497 <li>Year / Month / Day</li> 498 <li>Hour (24-hour format) : Minute : Second</li> 499 </ul> 500 ]]></item> 501 </group> 502 503 <group id="login" title="Login panel"> 504 <item id="remember_login" title="Remain logged in with this browser"><![CDATA[ 505 <h2>Remain logged in with this browser</h2> 506 <p>When checked, you will remain logged in to your Textpattern account with the current web browser, until you choose to log out. If left unchecked, you will be automatically logged out after a period of inactivity.</p> 507 <p>Requires cookies to be enabled in your browser.</p> 508 ]]></item> 509 </group> 510 511 <group id="plugin" title="Plugin panel"> 512 <item id="install_plugin" title="Install plugin"><![CDATA[ 513 <h2>Install plugin</h2> 514 <p>Paste the contents of the plugin text file here, then use ‘Upload’ to begin installation. Any plugin you upload with the same name as one you have previously installed will be overwritten with the uploaded version.</p> 515 <p>The plugin text you paste here is <strong>not</strong> the raw PHP code but Base64-encoded text, usually preceded by a header containing plugin information (such as plugin name, version and description, author name, etc).</p> 516 ]]></item> 517 <item id="upload_plugin" title="Upload plugin"><![CDATA[<h2>Upload plugin</h2> 518 <p>Use this form to upload a plugin file (either a PHP file or a zipped archive). Uploaded plugins (and any assets) are stored within the ‘plugins’ directory.</p> 519 <p>Any plugin you upload with the same name as one you have previously installed will be overwritten with the uploaded version.</p>]]></item> 520 </group> 521 522 <group id="prefs" title="Preferences panel"> 523 <item id="admin_side_plugins" title="Use admin-side plugins?"><![CDATA[ 524 <h2>Use admin-side plugins?</h2> 525 <p>Admin-side plugins can change the operation of the administration interface. They might hook into already existing actions, like editing or publishing articles, or they might add new panels for added/extended functionality.</p> 526 <p>If you would like to learn more about admin-side plugins, please see the <a rel="external" target="_blank" href="https://docs.textpattern.com/development/">Extending Textpattern</a> page in <a rel="external" target="_blank" href="https://docs.textpattern.com/">Textpattern User Documentation</a>. Plugins of all sorts are listed in the <a rel="external" target="_blank" href="https://plugins.textpattern.com/">Textpattern Plugins</a> site.</p> 527 ]]></item> 528 <item id="advanced_options" title="Advanced options"><![CDATA[ 529 <h2>Advanced options</h2> 530 <p>Show the advanced preferences group, where additional settings can be configured such as:</p> 531 <ul> 532 <li>PHP functions enabled in <code>txp:evaluate</code>.</li> 533 <li>Custom form template types.</li> 534 </ul> 535 ]]></item> 536 <item id="allow_article_php_scripting" title="Allow PHP in articles?"><![CDATA[ 537 <h2>Allow PHP in articles?</h2> 538 <p>When enabled, this setting will allow use of PHP within articles. The author must have sufficient privileges to do so (by default, only <a rel="external" target="_blank" href="https://docs.textpattern.com/administration/user-roles-and-privileges">‘Publishers’ <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> and <a rel="external" target="_blank" href="https://docs.textpattern.com/administration/user-roles-and-privileges">‘Managing Editors’ <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> can).</p> 539 <p>PHP code must have opening and closing PHP tags omitted, and also be enclosed within <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/php"><code><txp:php></code> tags <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a>.</p> 540 ]]></item> 541 <item id="allow_form_override" title="Allow form override?"><![CDATA[ 542 <h2>Allow form override?</h2> 543 <p>This setting allows article authors to override the form to be used when their article is rendered. If enabled, an ‘Override form’ dropdown will be available under ‘Advanced options’, when editing an article.</p> 544 ]]></item> 545 <item id="allow_page_php_scripting" title="Allow PHP in pages?"><![CDATA[ 546 <h2>Allow PHP in pages?</h2> 547 <p>When enabled, this setting allows PHP code within page templates and form templates.</p> 548 <p>PHP code must have opening and closing PHP tags omitted, and also be enclosed within <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/php"><code><txp:php></code> tags <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a>.</p> 549 ]]></item> 550 <item id="archive_dateformat" title="Archive date format"><![CDATA[ 551 <h2>Archive date format</h2> 552 <p>How dates will appear on articles in sections of your site.</p> 553 ]]></item> 554 <item id="articles_use_excerpts" title="Use excerpts on articles?"><![CDATA[ 555 <h2>Use excerpts on articles?</h2> 556 <p>By choosing ‘No’ the excerpt field will not be shown to the author on the article editing screen.</p> 557 ]]></item> 558 <item id="attach_titles_to_permalinks" title="Attach titles to permalinks?"><![CDATA[ 559 <h2>Attach titles to permalinks?</h2> 560 <p>This setting will attach a automatically-generated version of the article title to the URL. It is either generated automatically or can be manually overridden in ‘URL-only title’ when editing an article.</p> 561 <p>The setting will only have an effect when you are using clean URLs. For certain languages this may result in long and ugly URLs, in which case you probably want to set this to ‘Off’.</p> 562 ]]></item> 563 <item id="auto_dst" title="Automatically adjust Daylight Saving Time?"><![CDATA[ 564 <h2>Automatically adjust Daylight Saving Time?</h2> 565 <p>This setting allows Textpattern to alter when DST (Daylight Savings Time) occurs in your locale. If this is set to ‘No’, you will be able to change the ‘DST enabled’ preference manually.</p> 566 ]]></item> 567 <item id="comment_means_site_updated" title="New comment means site updated?"><![CDATA[ 568 <h2>New comment means site updated?</h2> 569 <p>The Textpattern database keeps track of when the most recent change to your site took place. When this setting is set to ‘Yes’, a new comment will also update this value. This value is used for example for <code>"Send Last-Modified header"</code> functionality.</p> 570 ]]></item> 571 <item id="comment_nofollow" title="Apply rel="nofollow" to comments?"><![CDATA[ 572 <h2>Apply rel="nofollow" to comments?</h2> 573 <p>If set to ‘Yes’, this will add an additional attribute to the links made in comments. It is intended to be a measure that takes away the incentive for comment spammers and was initiated by a range of search engines and software developers. You can find out more by reading <a rel="external" target="_blank" href="https://googleblog.blogspot.com/2005/01/preventing-comment-spam.html">Google’s announcement <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a>.</p> 574 <p><strong>Note:</strong> This setting does not influence the functionality of your site. It may prevent or diminish the influence of your comments when some search engines rank sites linked to from those comments.</p> 575 ]]></item> 576 <item id="comments_are_ol" title="Present comments as a numbered list?"><![CDATA[ 577 <h2>Present comments as a numbered list?</h2> 578 <p>Determines whether article comments will be wrapped with the HTML <code><ol></code> tag and individual comments will be wrapped in the <code><li></code> tag (causing comments to be presented as a numbered list), or whether individual comments will be wrapped with the <code><div></code> tag instead.</p> 579 <p>With either value, you can override the tags used on an individual form basis by modifying the <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/comments"><code><txp:comments /></code> tag <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a>, found in the <code>comments_display</code> form.</p> 580 ]]></item> 581 <item id="comments_auto_append" title="Automatically append comments to articles?"><![CDATA[ 582 <h2>Automatically append comments to articles?</h2> 583 <p>This setting determines whether comments and the comment form are automatically appended to all individual articles (by automatically including the contents of the <code>comments_display</code> form).</p> 584 <p>The majority of the time, you will want this set to ‘No’, as this allows greater flexibility to the positioning of your comments in your site design. You will need to add the <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/comments"><code><txp:comments /></code> tag <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> manually in any article-based templates where you want comments to appear.</p> 585 <p>If you are experiencing duplicate display of comments in an article, then chances are your templates have the <code><txp:comments /></code> tag in a template but also have ‘Automatically append comments to articles?’ set to ‘Yes’ too.</p> 586 ]]></item> 587 <item id="comments_dateformat" title="Comments date format"><![CDATA[ 588 <h2>Comments date format</h2> 589 <p>How comment dates will appear to your site visitors.</p> 590 ]]></item> 591 <item id="comments_default_invite" title="Default comments invite"><![CDATA[ 592 <h2>Default comments invite</h2> 593 <p>If you allow visitors to comment on your site, this is the default invitation text. For example:</p> 594 <ul> 595 <li>Comments</li> 596 <li>Add a comment</li> 597 <li>Feedback</li> 598 <li>Annotate</li> 599 </ul> 600 <p>Note that the invitation text can always be changed on a per-article basis.</p> 601 ]]></item> 602 <item id="comments_disabled_after" title="Comments disabled after"><![CDATA[ 603 <h2>Comments disabled after</h2> 604 <p>Use this to set the amount of time after which commenting will be turned off for articles (can be set to ‘Never’ to allow indefinite time to comment).</p> 605 ]]></item> 606 <item id="comments_disallow_images" title="Allow commenter images in comments?"><![CDATA[ 607 <h2>Allow commenter images in comments?</h2> 608 <p>With this option set to ‘No’, any images included in comments will be stripped out.</p> 609 ]]></item> 610 <item id="comments_mode" title="Comments mode"><![CDATA[ 611 <h2>Comments mode</h2> 612 <p>If ‘nopopup’ is selected (recommended) the current window will be refreshed to display only the current article, with comments beneath.</p> 613 <p>If ‘popup’ is selected, a new browser window will open when the comments link is clicked (this uses the <code>popup_comments</code> form).</p> 614 ]]></item> 615 <item id="comments_moderate" title="Moderate comments?"><![CDATA[ 616 <h2>Moderate comments?</h2> 617 <p>With this set to ‘Yes’, every new comment will have its visibility turned off until it has been reviewed. You must manually moderate and make each comment visible (a message will be emailed to the article author when a new comment has been received).</p> 618 ]]></item> 619 <item id="comments_on_default" title="Comments on by default?"><![CDATA[ 620 <h2>Comments on by default?</h2> 621 <p>If this is set to ‘Yes’, comments will be automatically enabled for every article published. If set to ‘No’, you must enable comments on the article ‘Write’ panel each time you want to accept comments.</p> 622 <p>Note that allowing comments can be turned on or off at any time, on a per-article basis.</p> 623 ]]></item> 624 <item id="comments_require_email" title="Comments require commenter’s email address?"><![CDATA[ 625 <h2>Comments require user’s email address?</h2> 626 <p>If set to ‘Yes’, people that want to comment on your article will have to enter an email address in the comment input form. They will be unable to post a comment if they do not supply an email address.</p> 627 ]]></item> 628 <item id="comments_require_name" title="Comments require commenter’s name?"><![CDATA[ 629 <h2>Comments require commenter’s name?</h2> 630 <p>If set to ‘Yes’, people that want to comment on your article will have to enter a name in the comment input form. They will not be able to submit a comment if they do not supply a name.</p> 631 ]]></item> 632 <item id="comments_sendmail" title="Email comments to author?"><![CDATA[ 633 <h2>Email comments to author?</h2> 634 <p>If set to ‘Yes’, whenever a new comment is received on an article, a copy will be sent via email to that article’s author.</p> 635 ]]></item> 636 <item id="comments_use_fat_textile" title="Allow more Textile markup in comments?"><![CDATA[ 637 <h2>Allow more Textile markup in comments?</h2> 638 <p>When set to ‘Yes’, comments may contain <a rel="external" target="_blank" href="https://textpattern.com/textile-sandbox">Textile <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> elements which would otherwise be treated as plain text, such as:</p> 639 <ul> 640 <li>headings</li> 641 <li>ordered and unordered lists</li> 642 <li>footnotes</li> 643 <li>tables</li> 644 <li>code</li> 645 <li>extended block syntax (<code>bc..</code>, <code>bq..</code>, etc.)</li> 646 </ul> 647 <p><strong>Note:</strong> For security reasons, raw HTML is transformed into regular text.</p> 648 ]]></item> 649 <item id="custom_form_types" title="Custom form template types"><![CDATA[ 650 <h2>Custom form template types</h2> 651 <p>In addition to the standard form template types (article, file, misc, etc.), Publishers can define custom types. The purpose of custom form template types is twofold: easier form template classification and custom asset definitions.</p> 652 <p>The format of the preference is <a rel="external" target="_blank" href="https://en.wikipedia.org/wiki/INI_file">INI <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a>, with each section corresponding to a form template type.</p> 653 <p>To define a custom form type (e.g. <code>js</code>) one must append (on a separate line) a <code>[js]</code> section. A default title can be set via a <code>title="Javascript"</code> entry in the corresponding section. If needed, localized titles can be appended too (e.g. <code>ru="Скрипт"</code>).</p> 654 <p>Additionally, a form template <a rel="external" target="_blank" href="https://www.iana.org/assignments/media-types/media-types.xhtml">media type <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> (formerly known as a MIME type) can be specified, e.g. <code>mediatype="application/javascript"</code>. This turns form templates of this type into custom assets that can be served as the set media type, either from the database or from disk (flat files) via the <code><txp:output_form /></code> tag. For example, a form template named <code>myscript.js</code> of <code>[js]</code> type with a media type of <code>application/javascript</code> can be included in your code like so:</p> 655 <pre><code><txp:output_form form="myscript.js" 656 format="flat.script" /></code></pre> 657 <p>This will generate the following HTML <code><script></code> tag:<p> 658 <pre><code><script src="path/to/flat/myscript.js"></script></code></pre> 659 <p>Only form templates with the name extension corresponding to their type (e.g. <code>myscript.js</code>) can be served as flat files. In this case, they will not be processed by Textpattern at all and are accessible via their URL.</p> 660 If a form template needs processing (if it contains Textpattern tags), you must serve it from the database. In this case you shouldn’t add the extension to the form name - call it just <code>myscript</code> (without <code>.js</code>) to make it inaccessible via a standard URL - and include it like so:</p> 661 <pre><code><txp::myscript format="script" /></code></pre> 662 ]]></item> 663 <item id="custom_overview" title="Custom fields"><![CDATA[ 664 <h2>Custom fields</h2> 665 <p>Custom fields are used to hold additional article data. You may define up to ten by giving them a name here. Each will appear as a separate field on the Write panel, to permit custom data to be associated with each article.</p> 666 <p>You may name the fields in any manner you wish, but be aware of the following:</p> 667 <ul> 668 <li>Using spaces improves legibility on the Write panel, but the fields may then <em>not</em> be used as sorting or filtering parameters in an article_custom tag. Consider underscores instead if you wish to use this functionality.</li> 669 <li>Be careful when naming fields that they do not clash with reserved field names in Textpattern. For example, do not use <code>title</code>, <code>category</code>, <code>limit</code>, <code>status</code>, etc as you will obtain strange results or broken sites.</li> 670 <li>Data in each field is limited to 255 characters of text only.</li> 671 </ul> 672 ]]></item> 673 <item id="dateformat" title="Date format"><![CDATA[ 674 <h2>Date format</h2> 675 <p>This option will affect how article dates appear on the front page of your site only.</p> 676 ]]></item> 677 <item id="default_event" title="Default panel"><![CDATA[ 678 <h2>Default panel</h2> 679 <p>The Textpattern administration interface panel that will appear first when anybody logs in.</p> 680 ]]></item> 681 <item id="default_publish_status" title="Default publishing status"><![CDATA[ 682 <h2>Default publishing status</h2> 683 <p>Defines the publishing visibility status of newly-created Textpattern articles.</p> 684 <p>Note this preference setting does not affect the status or articles created or edited prior to any change.</p> 685 <p>The default publishing status is one of the following:</p> 686 <ul> 687 <li>Draft</li> 688 <li>Hidden</li> 689 <li>Pending</li> 690 <li>Live</li> 691 <li>Sticky</li> 692 </ul> 693 <p>A <strong>draft</strong> article is considered a work-in-progress and is not viewable outside of the Textpattern administration area (i.e. not visible on the Textpattern front side and not syndicated in feeds).</p> 694 <p>A <strong>hidden</strong> article is not viewable outside of the Textpattern administration area.</p> 695 <p>A <strong>pending</strong> article is considered ready for publication and awaiting approval, but is not viewable outside of the Textpattern administration area.</p> 696 <p>A <strong>live</strong> article is typically viewable outside the Textpattern administration area (i.e. visible on the Textpattern front side, syndicated in feeds if the preference permits). If an article is live and has an expiration date, the status will remain as live after that date has been reached, but the article only appears outside the administration area if expired articles are permitted to be published.</p> 697 <p>A <strong>sticky</strong> article is similar to a <strong>live</strong> article insofar as it can be viewed outside the Textpattern administration area but will <strong>not</strong> appear in article lists unless the respective <code>article</code> or <code>article_custom</code> tag includes a <code>status</code> attribute with a <code>sticky</code> value.</p> 698 ]]></item> 699 <item id="doctype" title="Doctype"><![CDATA[ 700 <h2>Doctype</h2> 701 <p>Select which HTML doctype you wish to use (either HTML5 or XHTML). This affects comment input forms, Textile rendering of <code><abbr></code> or <code><acronym></code>, and <code><link></code> tags generated by <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/css"><code><txp:css /></code> <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a>.</p> 702 ]]></item> 703 <item id="enable_dev_preview" title="Enable development theme preview?"><![CDATA[ 704 <h2>Enable development theme preview?</h2> 705 <p>Users with sufficient privileges (by default, those with Publisher and Designer roles) can safely develop and preview a new theme while all other users will still see the old theme (until the new one is deployed).</p> 706 <p>However, privileged users who do not wish to participate in themes development can disable the development theme preview. They will then be served the current ‘public’ theme, like standard site visitors.</p> 707 ]]></item> 708 <item id="enable_short_tags" title="Enable short tag support?"><![CDATA[ 709 <h2>Enable short tag support?</h2> 710 <p>Textpattern tags take the form <code><txp:tag_name attribute1="value" ... /></code>. It is possible to reduce the amount of typing involved by enabling a shorthand notation whereby the <code>txp:</code> may be omitted by following a few simple guidelines. Here are some examples to demonstrate the concept:</p> 711 <ul> 712 <li><code><txp:article_id /></code> becomes <code><article::id /></code></li> 713 <li><code><txp:recent_articles/></code> becomes <code><recent::articles /></code></li> 714 <li><code><txp:file_download_list /></code> becomes <code><file::download_list /></code></li> 715 <li><code><txp:smd_if /></code> becomes <code><smd::if /></code></li> 716 <li><code><txp:smd_if> ... <txp:else /> ... </txp:smd_if></code> becomes <code><smd::if> ... <smd::else /> ... </smd::if></code> (note that the plugin prefix can be used for the <code>else</code> tag).</li> 717 </ul> 718 <p>If a tag contains an underscore and you enable short tags, the basic concept is:</p> 719 <ol> 720 <li>Remove the <code>txp:</code> prefix.</li> 721 <li>Replace the first occurrence of the underscore for <code>::</code>.</li> 722 </ol> 723 <p>Note that setting this preference does not affect the ability to use <code><txp:output_form /></code> short codes to render form snippets. You can still use <code><txp::shortcode /></code>, which will be interpreted as <code><txp:output_form form="shortcode" /></code>.</p> 724 ]]></item> 725 <item id="enable_xmlrpc_server" title="Enable XML-RPC server?"><![CDATA[ 726 <h2>Enable XML-RPC server?</h2> 727 <p>If you wish to use <a rel="external" target="_blank" href="https://en.wikipedia.org/wiki/XML-RPC">XML-RPC <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> for controlling Textpattern remotely (e.g. desktop or mobile apps) you must switch the XML-RPC server on by setting this to ‘Yes’.</p> 728 ]]></item> 729 <item id="expire_logs_after" title="Logs expire after how many days?"><![CDATA[ 730 <h2>Logs expire after how many days?</h2> 731 <p>When Textpattern logging is enabled, you can specify how long (in days) the logs should be kept. ‘7’ will keep the logs available for seven days.</p> 732 <p><strong>Note:</strong> The logs only get trimmed when you view the ‘Visitor logs’ panel, and will otherwise continue to grow in size.</p> 733 ]]></item> 734 <item id="file_base_path" title="File directory path"><![CDATA[ 735 <h2>File directory path</h2> 736 <p>This sets the <strong>absolute path</strong> to the directory where file uploads will be permanently saved. PHP needs to have write access to this directory.</p> 737 ]]></item> 738 <item id="file_max_upload_size" title="Maximum file size of uploads (in bytes)"><![CDATA[ 739 <h2>Maximum file size of uploads (in bytes)</h2> 740 <p>You can restrict the maximum size (in bytes) for file uploads. Note that this value is also limited by the configuration of PHP. If Textpattern detects that your PHP configuration limits upload size to a smaller value, it will automatically correct downwards. If you want to allow larger file uploads via upload from the browser, contact your host (the relevant values in <code>php.ini</code> are <code>post_max_size</code>, <code>upload_max_filesize</code> and <code>memory_limit</code>).</p> 741 ]]></item> 742 <item id="gmtoffset" title="Time zone"><![CDATA[ 743 <h2>Time zone</h2> 744 <p>In order to display dates in your local time zone, please select your time zone.</p> 745 ]]></item> 746 <item id="img_dir" title="Image directory"><![CDATA[ 747 <h2>Image directory</h2> 748 <p>If you’d like to customize the name of your images directory, you can do so here. You must first create the directory in the root of your Textpattern installation, you should also make sure that PHP is able to write to that directory.</p> 749 <p>This path is always a <strong>relative path</strong> (to the directory of your root Textpattern installation).</p> 750 <p>The default is <code>images</code>.</p> 751 ]]></item> 752 <item id="include_email_atom" title="Include email address in Atom feeds?"><![CDATA[ 753 <h2>Include email address in Atom feeds?</h2> 754 <p>This allows you to include the email address of the author (as set in their user account) of an article in the <code>author</code> part of your Atom feeds.</p> 755 ]]></item> 756 <item id="is_dst" title="Daylight Saving Time enabled?"><![CDATA[ 757 <h2>Daylight Saving Time enabled?</h2> 758 <p>Whether DST (Daylight Saving Time) is currently enabled for your time zone.</p> 759 ]]></item> 760 <item id="logging" title="Logging"><![CDATA[ 761 <h2>Logging</h2> 762 <p>You can select the level of visitor logging carried out by Textpattern:</p> 763 <ul> 764 <li><strong>All hits:</strong> Textpattern will log all page views on your site</li> 765 <li><strong>Referrers only:</strong> Textpattern will only log visits referred from other sites</li> 766 <li><strong>None:</strong> Textpattern will not log any page views</li> 767 </ul> 768 <p>From Textpattern 4.7.0, no visitor IP address information is collected or stored by Textpattern. If you collect or store IP addresses outside of Textpattern, please take appropriate precautions to store and/or use the data in accordance with any applicable laws, such as <a rel="external" target="_blank" href="https://en.wikipedia.org/wiki/General_Data_Protection_Regulation">GDPR <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a>, and employ strong security in every facet of your server and Textpattern installation to avoid this data being compromised.</p> 769 <p>It is strongly advised that you leave this setting at its default, ‘None’, unless you absolutely need this information and, further, publicly state your intended usage of it.</p> 770 ]]></item> 771 <item id="max_url_len" title="Maximum URL length (in characters)"><![CDATA[ 772 <h2>Maximum URL length (in characters)</h2> 773 <p>This prevents URLs that are longer than the specified length from functioning. It could be helpful in damage limitation and site security.</p> 774 ]]></item> 775 <item id="module_pophelp" title="Display admin-side inline help links"><![CDATA[ 776 <h2>Display admin-side inline help links</h2> 777 <p>If you wish to hide admin-side inline help links (Textpattern help pop-up windows) throughout the system, switch this setting to ‘None’.</p> 778 ]]></item> 779 <item id="never_display_email" title="Hide commenter‘s email address?"><![CDATA[ 780 <h2>Hide commenter‘s email address?</h2> 781 <p>This setting controls whether the email address of a commenter should be shown publicly.</p> 782 <p>It’s recommended that email addresses should not be shown, as courtesy to your users, but there may be certain situations when showing commenter email addresses is desirable.</p> 783 ]]></item> 784 <item id="override_emailcharset" title="Use ISO-8859-1 encoding in emails (default is UTF-8)?"><![CDATA[ 785 <h2>Use ISO-8859-1 encoding in emails (default is UTF-8)?</h2> 786 <p>Textpattern uses UTF-8 encoding wherever possible by default, including for outgoing emails. However, some older email clients (including some versions of Microsoft Outlook) do not have proper UTF-8 support. If you encounter garbled characters in emails, this setting will convert text to ISO-8859-1 encoding before sending them.</p> 787 <p><strong>Note:</strong> If you are using a language the characters of which cannot be represented in ISO-8859-1, this setting will unfortunately not help you. You should try finding a UTF-8 (or Unicode) compatible email client.</p> 788 ]]></item> 789 <item id="permlink_format" title="Permalink title URL pattern"><![CDATA[ 790 <h2>Permalink title URL pattern</h2> 791 <p>This defines the method by which article URLs are constructed and assigned when a non-messy mode is used.</p> 792 <p>When an article is published, its URL is generated from the article title unless a specific URL is provided in in the URL-only title field.</p> 793 <p>Take the following example article title: <em>Ann and Bob eat cake</em></p> 794 <p>When permalink title URL pattern option is set to ‘Hyphenated (title-like-this)’, the URL for the article would be:</p> 795 <pre><code>https://example.com/ann-and-bob-eat-cake</code></pre> 796 <p>When permalink title URL pattern option is set to ‘Intercapped (TitleLikeThis)’, the URL for the article would be:</p> 797 <pre><code>https://example.com/AnnandBobeatcake</code></pre> 798 ]]></item> 799 <item id="permlink_mode" title="Article URL pattern"><![CDATA[ 800 <h2>Article URL pattern</h2> 801 <p>This defines the method by which individual articles are reached via the URL displayed using the <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/permlink"><code><txp:permlink></code> tag <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a>.</p> 802 <p>‘?=messy’ mode is the most compatible - it will work with little to no configuration required - but least beneficial in terms of URL readability and search engine optimization (SEO). In this mode URLs for articles on your site would look like this:</p> 803 <pre><code>https://example.com/index.php?id=123</code></pre> 804 <p>All other modes require the web server’s URL rewrite functionality (e.g. Apache <code>mod_rewrite</code> or NGINX rewrite directives in the <code>server</code> block). If your server does not support URL rewrite functionality either contact your web host or use the ‘?=messy’ mode outlined above.</p> 805 ]]></item> 806 <item id="plugin_cache_dir" title="Plugin cache directory path"><![CDATA[ 807 <h2>Plugin cache directory path</h2> 808 <p>This setting is mainly used for plugin developers. When specified, you can put the plugin source file (not compiled) in this directory and Textpattern will load it automatically, so you can easily edit the plugin and immediately see the effect it has without having to install/activate the plugin. <strong>Beware</strong> though that by using this method, a broken plugin (which fails to compile) may also break Textpattern!</p> 809 <p>It is recommended that you load plugins through the standard ‘Plugins’ panel on a production site, rather than using the plugin cache directory.</p> 810 <p><strong>Note:</strong> Do not specify the same directory for both ‘temporary’ and ‘plugin cache’, as this will cause problems (Textpattern would try to run the contents of temporary log files as plugins).</p> 811 ]]></item> 812 <item id="production_status" title="Production status"><![CDATA[ 813 <h2>Production status</h2> 814 <p>A Textpattern site has one of three modes:</p> 815 <ol> 816 <li>‘Debugging’</li> 817 <li>‘Testing’</li> 818 <li>‘Live’</li> 819 </ol> 820 <h3>Debugging mode</h3> 821 <p>All PHP error reporting on your live site will be visible, as will warnings about malfunctioning code and plugins. In addition, the following information will be visible when you view the HTML source of live pages:</p> 822 <ul> 823 <li>the time it took the server to build the page (‘Runtime’)</li> 824 <li>the number of MySQL queries executed</li> 825 <li>approximate peak memory usage</li> 826 <li>all Textpattern tags encountered while building the page (also known as a tag trace)</li> 827 </ul> 828 <h3>Testing mode</h3> 829 <p>All PHP error reporting on your live site will be visible, as will warnings about malfunctioning code and plugins. The following information will be visible when you view the HTML source of live pages:</p> 830 <ul> 831 <li>the time it took the server to build the page (‘Runtime’)</li> 832 <li>the number of MySQL queries executed</li> 833 <li>approximate peak memory usage</li> 834 </ul> 835 <h3>Live mode</h3> 836 <p>No error reporting or diagnostic information will be sent to the page. Generally, Live mode is preferred, as it provides the best user experience and imposes the least overhead on the server.</p> 837 ]]></item> 838 <item id="public_theme_name" title="Front-side theme"><![CDATA[ 839 <h2>Front-side theme</h2> 840 <p>The default front-side theme that will be used when anybody visits your public-facing website. A pre-installed default theme is included with Textpattern, plus the option of starting without a theme. You can also add theme packages to the <code>textpattern/themes</code> directory to make them available for use.</p> 841 ]]></item> 842 <item id="publish_expired_articles" title="Publish expired articles?"><![CDATA[ 843 <h2>Publish expired articles?</h2> 844 <p>When set to ‘Yes’, expired articles will continue to show on your site after their expiry date has elapsed. You can use the <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/if_expired"><code><txp:if_expired /></code> tag <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> to show alternate content or markup for expired articles.</p> 845 <p>When set to ‘No’, expired articles will be removed from the public site and return a "410 Gone" HTTP status instead. The default setting is ‘No’.</p> 846 ]]></item> 847 <item id="publisher_email" title="Send login details from this email address"><![CDATA[ 848 <h2>Send login details from this email address</h2> 849 <p>Specify an email address which is used as the sender’s ‘From:’ address on messages with login information for new users.</p> 850 <p>If this preference is left blank or contains an invalid email address, Textpattern uses the name and address of the currently logged-in user instead.</p> 851 ]]></item> 852 <item id="rss_how_many" title="How many articles should be included in feeds?"><![CDATA[ 853 <h2>How many articles should be included in feeds?</h2> 854 <p>This is the maximum number of current articles to be syndicated at a time, in RSS and Atom formats.</p> 855 <p>A low value, such as <code>5</code> through <code>15</code> is recommended.</p> 856 ]]></item> 857 <item id="send_lastmod" title="Send "Last-Modified" header?"><![CDATA[ 858 <h2>Send "Last-Modified" header?</h2> 859 <p>When set, Textpattern will read a visitor’s HTTP <code>If-Modified-Since</code> header (if one exists) and compare it to the last site update. If nothing has changed since the visitor last loaded the page (i.e. if the timestamp the browser sends is the same as the last site update), then a header is sent back instructing the visitor’s browser to use its cached version of the page.</p> 860 <p>This can reduce bandwidth consumption, page load times, and web server load.</p> 861 ]]></item> 862 <item id="show_comment_count_in_feed" title="Show comment count in feeds?"><![CDATA[ 863 <h2>Show comment count in feeds?</h2> 864 <p>When set to ‘Yes’, this setting will append the number of comments to your article titles in RSS/Atom feeds.</p> 865 ]]></item> 866 <item id="site_slogan" title="Site slogan"><![CDATA[ 867 <h2>Site slogan</h2> 868 <p>The <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/site_slogan">site slogan <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> is a summary or description of your site. It will be used as the description of your site wherever required, such as in your RSS/Atom feeds, and may be used at any number of places throughout your site, at your discretion.</p> 869 ]]></item> 870 <item id="sitename" title="Site name"><![CDATA[ 871 <h2>Site name</h2> 872 <p>The <a rel="external" target="_blank" href="https://docs.textpattern.com/tags/site_name">name or title of your site <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a>. This will appear in the title bar of a visitor’s browser or syndication feed reader, and any number of other places throughout your site, at your discretion.</p> 873 <p><strong>Note:</strong> The site slogan is optional, but may be required for a valid RSS or Atom feed.</p> 874 ]]></item> 875 <item id="siteurl" title="Site URL"><![CDATA[ 876 <h2>Site URL</h2> 877 <p>This is the address of your Textpattern site, for example <code>www.example.com</code>.</p> 878 <p><strong>Note:</strong> No <code>http://</code>, <code>https://</code> or trailing slash <code>/</code> is required.</p> 879 ]]></item> 880 <item id="skin_dir" title="Theme directory"><![CDATA[ 881 <h2>Theme directory</h2> 882 <p>If you’d like to customize the name of the directory where front-side themes flat files will be permanently saved, you can do so here. You must first create the directory in the root of your Textpattern installation, you should also make sure that PHP is able to write to that directory.</p> 883 <p>This path is always a <strong>relative path</strong> (to the directory of your root Textpattern installation).</p> 884 <p>The default is <code>themes</code>.</p> 885 ]]></item> 886 <item id="smtp_from" title="SMTP envelope sender address"><![CDATA[ 887 <h2>SMTP envelope sender address</h2> 888 <p>This preference should be left blank unless you experience problems with sending email in Textpattern (if no email is sent at all). Should that problem arise, you can enter any valid email address here, although preferably one that has the same domain name as the website where you’ve installed Textpattern (i.e. if your website is <code>https://example.com</code>, you might use <code>you@example.com</code>).</p> 889 <p>For those interested in the technical details:</p> 890 <ul> 891 <li>On UNIX-like/macOS servers, the entered email address is used as the 4th parameter (prefixed with "-f") for the PHP <code>mail()</code> function</li> 892 <li>On Windows servers, the entered email address is used to set (or override) the <code>sendmail_from</code> php.ini setting</li> 893 </ul> 894 <p>This ensures that the SMTP envelope sender address (which is not necessarily the same as the "From:" header you normally see in emails) is set to the email address you’ve entered here, which is a requirement for sending email on some web servers.</p> 895 ]]></item> 896 <item id="spam_blacklists" title="Spam blocklists (comma-separated)"><![CDATA[ 897 <h2>Spam blocklists (comma-separated)</h2> 898 <p>The <a rel="external" target="_blank" href="https://en.wikipedia.org/wiki/Blacklisting">blocklist <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> providers entered here will be queried when a comment is posted to your blog, and the IP address of the comment poster will be checked. If the IP address is listed it means there has been one or more spamming reports made about this IP in the past, and the comment will be rejected. Irrespective of the check results, the IP address of the comment poster is not stored by Textpattern.</p> 899 <p>You can enter a list of domain names here, separated by commas. Please note that it is your responsibility to ensure blocklists are fit for purpose.</p> 900 ]]></item> 901 <item id="syndicate_body_or_excerpt" title="Syndicate article excerpt only?"><![CDATA[ 902 <h2>Syndicate article excerpt <strong>only</strong>?</h2> 903 <p>If this is set to ‘No’, feed items will contain the full article bodies.</p> 904 <p>If this is set to ‘Yes’, feed items will contain the article excerpt instead of the article body where it is available.</p> 905 ]]></item> 906 <item id="tempdir" title="Temporary directory path"><![CDATA[ 907 <h2>Temporary directory path</h2> 908 <p>Sets an <strong>absolute path</strong> to a temporary (sometimes know as ‘tmp’ or ‘temp’) directory. PHP needs to have write access to this directory. This directory is used for temporary files, for example uploads of any kind (plugins, files or images).</p> 909 <p><strong>Note:</strong> Do not specify the same directory for both ‘temporary’ and ‘plugin cache’, as this will cause problems (Textpattern would try to run the contents of temporary log files as plugins).</p> 910 ]]></item> 911 <item id="theme_name" title="Admin-side theme"><![CDATA[ 912 <h2>Admin-side theme</h2> 913 <p>The default admin-side theme that will be used when anybody logs into Textpattern. A number of pre-installed admin themes are included with Textpattern, and you can also add custom theme packages to the <code>textpattern/admin-themes</code> directory to make them available for use.</p> 914 ]]></item> 915 <item id="txp_evaluate_functions" title="PHP functions enabled in txp:evaluate"><![CDATA[ 916 <h2>PHP functions enabled in txp:evaluate</h2> 917 <p>This is a comma-separated list of <code>function</code> or <code>alias=function</code> items, e.g. <code>md5</code>, <code>replace=str_replace</code>. Items specified within this list can be utilized in the <code>query</code> attribute of the <code><txp:evaluate /></code> tag:</p> 918 <pre><code><txp:evaluate query="replace('cats', 'dogs', 'I like cats.')" /></code></pre> 919 <p><code>function</code> should return a scalar value (<strong>not</strong> an array/object).</p> 920 ]]></item> 921 <item id="use_comments" title="Accept comments?"><![CDATA[ 922 <h2>Accept comments?</h2> 923 <p>This sets whether Textpattern’s commenting functionality should be enabled or disabled.</p> 924 ]]></item> 925 <item id="use_mail_on_feeds_id" title="Use email address to construct feed IDs (default is site URL)?"><![CDATA[ 926 <h2>Use email address to construct feed IDs (default is site URL)?</h2> 927 <p>Items in an Atom feed require a unique ID.</p> 928 <p>To generate IDs unique to your site, Textpattern allows you to choose between either an email address or your domain name to include in these IDs. The email address will be the first one used when creating the site. Unless you are likely to be changing your domain name in the future, it is probably safe to set this to ‘No’.</p> 929 ]]></item> 930 <item id="use_plugins" title="Use plugins?"><![CDATA[ 931 <h2>Use plugins?</h2> 932 <p>This allows you to turn off all support for Textpattern plugins. This is useful if you are debugging errors on your site, and you want to make check if one or more plugins are involved.</p> 933 ]]></item> 934 <item id="use_textile" title="Use Textile?"><![CDATA[ 935 <h2>Use Textile?</h2> 936 <p><a rel="external" target="_blank" href="https://textpattern.com/textile-sandbox">Textile <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> is a utility intended to simplify the conversion of plain text to HTML. When enabled, Textile will process the body text of articles and return structurally sound HTML.</p> 937 <p>Textile also offers a powerful but easy-to-learn set of commands with which to format text, define structures such as lists, headers and blockquotes, and insert links and images.</p> 938 <p>The setting you choose here becomes the default for excerpt and body markup on the ‘Write’ panel. You can choose to allow complete Textile processing, to convert line breaks into HTML paragraph markers or not convert any text at all.</p> 939 ]]></item> 940 </group> 941 942 <group id="section" title="Sections panel"> 943 <item id="section_category" title="Introduction"><![CDATA[ 944 <h2>Introduction</h2> 945 <p>Sections in Textpattern are best thought of as analogous to sections in a newspaper; each belong to the same publication, but each might feature a different layout, or a different style of article, and so on.</p> 946 <p>For most websites, only a bare minimum of sections need be created.</p> 947 <h3>A likely scenario for a website with three sections:</h3> 948 <ol> 949 <li><strong>Archive:</strong> The ‘Section’ to which all articles that appear on the front page belong. Whenever a reader clicks on an article’s permanent link, it will be displayed in the page layout assigned to this ‘Section’. To go to a paged list of the most recent articles assigned to the section "Archive", the URL would be <code>https://example.com/archive/</code>.</li> 950 <li><strong>About:</strong> An ‘about this site’ page, which differs from the front page and the "Archive" section, in that it is more static, may have a different layout, and will likely contain only one article. The ‘About’ section would be reached at <code>https://example.com/about/</code>.</li> 951 <li><strong>Photos:</strong> A ‘Section’ whose differing layout (and possibly different CSS) would display photos instead of articles.</li> 952 </ol> 953 <p>Note that a special hidden section, named default, always exists. This default section uses the page named default and the style called default, and it constructs the front page of your site.</p> 954 ]]></item> 955 <item id="section_default" title="Default publishing section"><![CDATA[ 956 <h2>Default publishing section</h2> 957 <p>This option governs which section will be pre-selected in the Section menu when creating a new article on the ‘Write’ panel.</p> 958 <p>If most of your articles end up belonging to a particular section, select it from the list here. Changes will be reflected immediately.</p> 959 <p>You can override this on a per-article basis in the ‘Write’ panel by selecting a different section in the ‘Sort and display’ pane.</p> 960 ]]></item> 961 <item id="section_description" title="Description"><![CDATA[ 962 <h2>Description</h2> 963 <p>The section description is an optional component that can help search engines and website crawlers better identify and sort content.</p> 964 <p>The article description is limited to a maximum of 255 characters. Note that some search engines place character limits on the length of a page’s <code>meta description</code> for practicality of display in search engine results pages (SERPs) and this may be less than the 255 character limit in Textpattern.</p> 965 ]]></item> 966 <item id="section_on_frontpage" title="Section articles appear on front page?"><![CDATA[ 967 <h2>Section articles appear on front page?</h2> 968 <p>The articles in some sections, such as those resembling more ‘static’ web pages, may seem out of place in the time-sensitive flow of your site’s front page.</p> 969 <p>Setting this to ‘No’ will prevent articles assigned to this section from appearing on the front page.</p> 970 ]]></item> 971 <item id="section_searchable" title="Include this section in site search?"><![CDATA[ 972 <h2>Include this section in site search?</h2> 973 <p>This governs whether articles belonging to this section should appear as part of site-wide search results.</p> 974 ]]></item> 975 <item id="section_syndicate" title="Syndicate articles in this section?"><![CDATA[ 976 <h2>Syndicate articles in this section?</h2> 977 <p>Governs whether or not articles in this section will appear in the site’s RSS and Atom feeds.</p> 978 ]]></item> 979 <item id="section_uses_css" title="Uses style"><![CDATA[ 980 <h2>Uses style</h2> 981 <p>If you wish to override the default stylesheet for a particular section, this can be set here.</p> 982 <p>This is only relevant to stylesheets held within Textpattern ‘Styles’ panel - if you host your CSS externally of Textpattern (which is highly recommended), this option has no effect.</p> 983 ]]></item> 984 <item id="section_uses_page" title="Uses page"><![CDATA[ 985 <h2>Uses page</h2> 986 <p>In Textpattern, sections are married to page templates. It’s kind of sweet, really…</p> 987 ]]></item> 988 <item id="section_uses_skin" title="Uses theme"><![CDATA[ 989 <h2>Uses theme</h2> 990 <p>If you wish to change the theme used for a particular section, this can be set here from the list of currently installed themes.</p> 991 ]]></item> 992 </group> 993 994 <group id="setup" title="Setup panel"> 995 <item id="setup_user_login" title="User login"><![CDATA[ 996 <h2>User login</h2> 997 <p>The login name of the administrator (‘Publisher’) account that you will use for administering of your site.</p> 998 <p>Although there are no restrictions on the name, it is best to avoid complicated character sequences and easily-guessed usernames (e.g. <code>admin</code>, <code>administrator</code>, etc.)</p> 999 ]]></item> 1000 <item id="setup_user_pass" title="User password"><![CDATA[ 1001 <h2>User password</h2> 1002 <p>Since this account has the highest level of access in Textpattern, choose a very strong password or, preferably, a passphrase.</p> 1003 <h3>Tips</h3> 1004 <ul> 1005 <li>Use a mixture of uppercase and lowercase characters</li> 1006 <li>Use numbers</li> 1007 <li>Use symbols</li> 1008 <li>Make it at least eight characters in length</li> 1009 <li><strong>Avoid</strong> any personal information (dates, names, places, family members, pets, etc.)</li> 1010 <li><strong>Avoid</strong> any sole or repeated dictionary words, regardless of spelling, language or case</li> 1011 </ul> 1012 ]]></item> 1013 <item id="table_prefix" title="Table prefix"><![CDATA[ 1014 <h2>Table prefix</h2> 1015 <p>You only need to use a table prefix if you require multiple Textpattern installations in one database. Each Textpattern installation needs a unique prefix.</p> 1016 <p>Note that the prefix must adhere to the following rules:</p> 1017 <ul> 1018 <li><strong>1st character:</strong> must be a-z, A-Z, or underscore</li> 1019 <li><strong>Subsequent characters:</strong> can only be a-z, A-Z, 0-9, or underscore</li> 1020 </ul> 1021 ]]></item> 1022 </group> 1023 1024 <group id="skin" title="Themes panel"> 1025 <item id="skin_author" title="Theme author"><![CDATA[ 1026 <h2>Theme author</h2> 1027 <p>The author(s) of this theme (optional).</p> 1028 ]]></item> 1029 <item id="skin_author_uri" title="Theme website"><![CDATA[ 1030 <h2>Theme website</h2> 1031 <p>The URL where full information and/or latest versions of this theme can be found (optional).</p> 1032 ]]></item> 1033 <item id="skin_delete_entirely" title="Delete theme templates from disk too"><![CDATA[ 1034 <h2>Delete theme templates from disk too</h2> 1035 <p>If checked, all template files in the selected theme(s) will be permanently deleted from disk. However, themes-related directories and their subdirectories will not be deleted if any other files (such as JavaScript, images, ...) exist within them.</p> 1036 ]]></item> 1037 <item id="skin_delete_from_database" title="Delete unused templates from database on import"><![CDATA[ 1038 <h2>Delete unused templates from database on import</h2> 1039 <p>If checked, each template in the selected theme(s) that does not have a corresponding file on disk will be permanently deleted from the database. The result after completion of the action will be that your database templates will reflect what is on disk as far as possible.</p> 1040 <p>Note that if you have removed template files that Textpattern requires, empty versions will be created for you in the database.</p> 1041 ]]></item> 1042 <item id="skin_delete_from_disk" title="Delete unused templates from disk on export"><![CDATA[ 1043 <h2>Delete unused templates from disk on export</h2> 1044 <p>If checked, each template file in the selected theme(s) that does not have a corresponding item in the database will be permanently deleted from the disk-based theme. The result after completion of the action will be that your file system templates will reflect exactly what is in the database.</p> 1045 ]]></item> 1046 <item id="skin_description" title="Theme description"><![CDATA[ 1047 <h2>Theme description</h2> 1048 <p>A brief summary of this theme design/layout can be provided (optional).</p> 1049 <p>The theme description is limited to a maximum of 255 characters.</p> 1050 ]]></item> 1051 <item id="skin_import" title="Import theme"><![CDATA[ 1052 <h2>Import theme from disk</h2> 1053 <p>This form allows you to import a theme into the Textpattern database from your themes directory.</p> 1054 <p>An importable theme must be composed of a readable parent folder using the theme name as the folder name, and within the folder a readable <code>manifest.json</code> file in the expected format. The theme folder should also contain pages, forms and styles into eponym subfolders.</p> 1055 <p>While pages and forms should use the <code>.txp</code> extension, stylesheets are expected to be <code>.css</code> files. Forms should also be grouped by type into dedicated directories. Textpattern will create any missing essential templates on import.</p> 1056 <p>See the <a rel="external" target="_blank" href="https://docs.textpattern.com/themes/">themes documentation <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> for further information on creating, installing and using themes within Textpattern CMS.</p> 1057 ]]></item> 1058 <item id="skin_name" title="Theme name"><![CDATA[ 1059 <h2>Theme name</h2> 1060 <p>A theme’s name is used for the directory name of the theme and other technical purposes (required).</p> 1061 <p>The name shouldn’t contain any special characters or spaces.</p> 1062 ]]></item> 1063 <item id="skin_overview" title="Introduction to Themes"><![CDATA[ 1064 <h2>Introduction to Themes</h2> 1065 <p>A Textpattern theme is a collection of Pages, Forms and Stylesheets. Themes allow you to logically separate your site assets into groups for ease of identification, or sharing with others. The act of creating or importing a Theme, and any assets it contains, does <em>not</em> have any impact on your existing site. You are free to edit or modify any asset that is not associated with a Section of your site, and it will not affect the site itself.</p> 1066 <p>To edit assets in a theme, visit the Pages, Forms or Styles panel and use the dropdown selector to choose the theme upon which you wish to work. The theme you are working on is remembered throughout the administration area, allowing you to jump between asset types quickly and easily. It is referred to as your <em>working theme</em>.</p> 1067 <p>Please consult the <a rel="external" target="_blank" href="https://docs.textpattern.com/build/themes-creating-using-and-sharing">Textpattern User Documentation <span class="ui-icon ui-icon-extlink">(opens an external link in a new window)</span></a> for further information.</p> 1068 ]]></item> 1069 <item id="skin_title" title="Theme title"><![CDATA[ 1070 <h2>Theme title</h2> 1071 <p>A theme’s descriptive title, used to identify the theme within Textpattern’s panels.</p> 1072 <p>The title can contain special characters and spaces.</p> 1073 ]]></item> 1074 <item id="skin_version" title="Theme version"><![CDATA[ 1075 <h2>Theme version</h2> 1076 <p>The version number of the installed version of this theme (optional).</p> 1077 ]]></item> 1078 </group> 1079 </help> 1080 </resources>
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
title