Textpattern

https://docs.textpattern.com
Admin
Textpattern is a flexible, open-source content management system for managing and publishing web...
Tokens:175,421
Snippets:2,918
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Multi-Site Folder Structure Example

Source: https://docs.textpattern.com/setup/multi-site-installation

This illustrates the directory structure for a single site within a multi-site Textpattern installation. Each site requires 'admin', 'private', and 'public' subdirectories.

```text
mydomain/
    admin/
    private/
    public/

```

--------------------------------

### Textpattern config.php File Example

Source: https://docs.textpattern.com/installation/index

This is an example of the Textpattern configuration file (config.php) that is generated during installation. It contains database connection details and file paths.

```php
<?php
    $txpcfg['db'] = 'database';
    $txpcfg['user'] = 'login';
    $txpcfg['pass'] = 'password';
    $txpcfg['host'] = 'localhost';
    $txpcfg['table_prefix'] = '';
    $txpcfg['txpath'] = '/var/www/vhosts/example.com/httpdocs/textpattern';
    $txpcfg['dbcharset'] = 'utf8mb4';
    $txpcfg['dbengine'] = 'InnoDB';
    $txpcfg['client_flags'] = 0;
?>
```

--------------------------------

### Example Download Link Short-tag

Source: https://docs.textpattern.com/tags/shortcodes/download-link-shortcode

An example of how to use the media_file short-tag to display a download link for a specific category, including its SHA256 checksum.

```textpattern
<txp::media_file category="current-release-zip" sha256="a868c05fc37108f2bb5e878cfbcdc61a82ce2646c4676cccb8105a6c6277be7a" />
```

--------------------------------

### Compressed Plugin Header Example

Source: https://docs.textpattern.com/administration/plugins-panel

Compressed plugins begin with a specific sequence that indicates their compressed format. This format requires gzip on the web server for installation.

```text
H4sIAAAAAAAAA919a3PbRrbg56Rq/kOH8UTkDiWKkh+xJCtXsWWPZxXHa8meeyvjUoFEk8QY
BGgAlKz1+L/vefULACk6dvZO3amJRTYa53SfPn3e3YwOHh58LA/uHnSyaK47h+XB/YNOOY8v
k4l8iZbVLC/wy3B40Dmv9EQ9…
```

--------------------------------

### Example Metadata for User Documentation Guidelines

Source: https://docs.textpattern.com/brand/user-docs-page-template

An example of a complete metadata block for a specific Textpattern documentation page.

```yaml
---
layout: document
category: brand
published: true
title: Development guidelines for Textpattern documentation
description: Guidelines for the development of Textpattern user documentation.
---

```

--------------------------------

### Install Base-64 Encoded Plugin

Source: https://docs.textpattern.com/build/plugins-installing-upgrading-and-using

Paste this Base-64 encoded text into the 'Install plugin' box in Textpattern admin. Ensure the entire file content is copied.

```text
YTo5OntzOjQ6Im5hbWUiO3M6Njoic21kX2lmIjtzOjY6ImF1dGhvciI7czoxMToiU3RlZi 
  Rhd3NvbiI7czoxMDoiYXV0aG9yX3VyaSI7czoyMjA6Imh0dHA6Ly9zdGVmZGF3c29uLmNvbS8i 
  O3M6NzoidmVyc2lvbiI7czo0OiIw…
```

--------------------------------

### Install Compressed Plugin

Source: https://docs.textpattern.com/build/plugins-installing-upgrading-and-using

This sequence indicates a compressed plugin file. Requires gzip on the web server for installation.

```text
H4sIAAAAAAAAA919a3PbRrbg56Rq/kOH8UTkDiWKkh+xJCtXsWWPZxXHa8meeyvjUoFEk8QY 
  BGgAlKz1+L/vefULACk6dvZO3amJRTYa53SfPn3e3YwOHh58LA/uHnSyaK47h+XB/YNOOY8v 
  k4l8iZbVLC/wy3B40Dmv9EQ9…
```

--------------------------------

### Full File Tree Scope Example

Source: https://docs.textpattern.com/brand/user-docs-guide

Use this example to display a full directory tree, including nested subdirectories and files. Apply selectors like `{:.directory--open}`, `{:.directory}`, `{:.document}`, `{:.image}`, and `{:.list--files}` to style the elements appropriately. Ensure file names include extensions.

```markdown
* {:.directory--open} parent_directory
  * {:.directory} child_directory1
  * . . .
  * {:.directory--open} child_directory4
    * {:.document} file1.ext
    * {:.document} file2.ext
    * {:.document} file3.ext
    * {:.image} image1.png
  * . . .
{:.list--files}

```

--------------------------------

### Example Plugin File Structure

Source: https://docs.textpattern.com/administration/plugins-panel

This is a hypothetical example showing the exact structure of a Textpattern plugin file, including header information and Base-64 encoded code.

```text
# Name: abc_myplugin v0.1
# Type: Client side plugin
# Brief Description of the plugin
# Author: Author name
# URL: https://example.com/
# Recommended load order: 5

# ……………………………………………………………
# This is a plugin for Textpattern - https://textpattern.com/
# To install: textpattern > admin > plugins
# Paste the following text into the 'Install plugin' box:
# ……………………………………………………………

YTo5OntzOjQ6Im5hbWUiO3M6Njoic21kX2lmIjtzOjY6ImF1dGhvciI7czoxMToiU3RlZiBE
YXdzb24iO3M6MTA6ImF1dGhvcl91cmkiO3M6MjI6Imh0dHA6Ly9zdGVmZGF3c29uLmNvbS8i
O3M6NzoidmVyc2lvbiI7czo0OiIw


```

--------------------------------

### Example Video Shortcode Call with Microdata

Source: https://docs.textpattern.com/tags/output_form

An example of calling the 'media_video' shortcode with specific attributes to include Schema.org microdata for name, description, and duration.

```textpattern
<txp::media_video width="720" mp4-url="/video/example.mp4" webm-url="/video/example.webm" poster-url="/video/example.png" name="Cat video" description="My great video of cats." duration-seconds="20" />

```

--------------------------------

### Container Tag Example - Messy URLs

Source: https://docs.textpattern.com/tags/section

HTML output for the container tag example with messy URLs.

```html
<a href="https://example.com/index.php?s=archive">My Archive</a>
```

--------------------------------

### Single Tag Example - Link Structure

Source: https://docs.textpattern.com/tags/section

This example constructs a link using the section tag twice: once to get the URL and once to get the section title.

```textpattern
<a href="<txp:section name="about" url="1" />">
    <txp:section name="about" title="1" />
</a>
```

--------------------------------

### Rendered Permalinks Example

Source: https://docs.textpattern.com/tags/learning

Shows the expected HTML output after Textpattern processes the 'permlink' container tag example. This demonstrates how tags are replaced with dynamic content.

```html
<a href="/articles/this-article-title">This article title</a>
…content…
<a href="/articles/this-article-title">Read more…</a>
```

--------------------------------

### Single Directory Scope Example

Source: https://docs.textpattern.com/brand/user-docs-guide

This example demonstrates how to display the contents of a single directory, excluding the parent directory for a cleaner look. Use selectors like `{:.directory}`, `{:.document}`, and `{:.image}`. Ensure file names include extensions.

```markdown
* . . .
* {:.directory} subdirectory2
* {:.directory} subdirectory3
* . . .
* {:.directory} subdirectory5
* . . .
* {:.document} file1.ext
* {:.document} file2.ext
* {:.image} image1.png
* . . .
{: .list--files}

```

--------------------------------

### Container Tag Example - Clean URLs

Source: https://docs.textpattern.com/tags/section

HTML output for the container tag example with clean URLs.

```html
<a href="https://example.com/archive/">My Archive</a>
```

--------------------------------

### Textpattern if_request Example: Check GET parameter 'size'

Source: https://docs.textpattern.com/tags/if_request

This example demonstrates how to use the if_request tag to check if the 'size' GET parameter is one of 'small', 'medium', or 'large'. If it matches, 'Thanks!' is displayed; otherwise, an error message is shown.

```textpattern
<txp:if_request name="size" type="get" match="any" value="small, medium, large">
    <p>Thanks!</p>
<txp:else />
    <p>Please specify a valid size value.</p>
</txp:if_request>


```

--------------------------------

### Kramdown Example List Styling

Source: https://docs.textpattern.com/brand/user-docs-guide

Use the '{:.example}' attribute to style unordered lists as example lists, featuring a light-blue border and circle bullet points.

```markdown
* item one
* item two
  * nested item one
  * nested item two
* item three
* etc
{:.example}

```

--------------------------------

### Video Embed Shortcode Example Usage

Source: https://docs.textpattern.com/tags/shortcodes/video-embed-shortcode

An example of how to use the Textpattern video embed shortcode with all available attributes populated. Optional attributes like poster-url, name, description, and duration-seconds enhance Schema.org microdata.

```textpattern
<txp::media_video width="640" height="480" mp4-url="/video/video1.mp4" webm-url="/video/video1.webm" poster-url="/video/video1-poster.png" name="Cat video" description="My great video of cats." duration-seconds="20" />

```

--------------------------------

### Display Link and Description

Source: https://docs.textpattern.com/tags/link_description

Example of how to display a link and its description content using the link and link_description tags within a paragraph.

```textpattern
<p>
    <txp:link />
    <br />
    <txp:link_description />
</p>
```

--------------------------------

### Aside Block Structure Example

Source: https://docs.textpattern.com/tags/shortcodes/aside-quote-shortcode

Shows the recommended structure for an aside block, including a quote and source information.

```html
<aside class="">
	<q> … </q>
	<p class=""><span class="name">Name</span> <span class="title">Title</span>
</aside>


```

--------------------------------

### Single Tag Example - Clean URLs

Source: https://docs.textpattern.com/tags/section

HTML output for the single tag example with clean URLs, displaying the 'About' section title as a link.

```html
<a href="https://example.com/about/">About</a>
```

--------------------------------

### Simple Article Tag Example

Source: https://docs.textpattern.com/tags/learning

Demonstrates a basic Textpattern tag that requires a single pass for rendering.

```textpattern
<txp:article />
...
<txp:link_to_next>Next article</txp:link_to_next>
```

--------------------------------

### Single Tag Example - Messy URLs

Source: https://docs.textpattern.com/tags/section

HTML output for the single tag example with messy URLs, displaying the 'About' section title as a link.

```html
<a href="https://example.com/index.php?s=about">About</a>
```

--------------------------------

### Textpattern Path Example

Source: https://docs.textpattern.com/brand/user-docs-guide

Illustrates how to display Textpattern-specific paths within code blocks. Ensure these elements reflect actual code.

```text
Textpattern path: __TXP-ROOT/textpattern
Article URL pattern: title_only
Temporary directory path: __TXP-ROOT/textpattern/tmp
```

--------------------------------

### Version Numbering Example

Source: https://docs.textpattern.com/tags/if_plugin

Illustrates semantic versioning for the version attribute, indicating a minimum version requirement.

```textpattern
version="4.6"


```

--------------------------------

### Kramdown Example Paragraph Styling

Source: https://docs.textpattern.com/brand/user-docs-guide

Apply the '{:.example}' attribute to style paragraphs as example text, distinguished by a light-blue border and lighter font color.

```markdown
The example paragraph text here.
{:.example}

```

--------------------------------

### Example: Displaying Keywords in an Article Form

Source: https://docs.textpattern.com/tags/meta_keywords

This example integrates the meta_keywords tag within an article form template to display keywords as topical tags. It uses the format attribute to output raw values and a separator for readability.

```html
<h1>
    <txp:permlink>
        <txp:title />
    </txp:permlink>
</h1>
<p>
    Date:
    <txp:posted />
</p>
<p>
    Keywords:
    <txp:meta_keywords format="" separator=", " />
</p>
<txp:excerpt />
<txp:body />
```

--------------------------------

### Messy URL Example

Source: https://docs.textpattern.com/installation/troubleshooting-textpattern

Shows the default URL format that Textpattern uses when clean URLs are not enabled.

```text
https://example.com/index.php?id=123
```

--------------------------------

### Output of Global Trim Example

Source: https://docs.textpattern.com/tags/learning

Shows the resulting output after the global 'trim' attribute is applied to the conditional statement.

```textpattern

    there is something to test


```

--------------------------------

### Display PHP Server Information

Source: https://docs.textpattern.com/tags/php

Example of using the Textpattern PHP tag to execute the `phpinfo()` function, displaying detailed server information.

```textpattern
<txp:php>
    phpinfo();
</txp:php>


```

--------------------------------

### Clean URL Example

Source: https://docs.textpattern.com/installation/troubleshooting-textpattern

Illustrates the clean URL format used by Textpattern for articles.

```text
https://example.com/articles/123/hello-world
```

--------------------------------

### Display Formatted File Size in Kilobytes

Source: https://docs.textpattern.com/tags/file_download_size

Example of how to display the file size formatted in kilobytes using the 'format' attribute.

```textpattern
<txp:file_download_size format="k" />
```

--------------------------------

### Display Link with Category Title

Source: https://docs.textpattern.com/tags/link_category

Example demonstrating how to display a link with its name and category title. It utilizes link_url and link_name tags for the link itself.

```textpattern
<a href="<txp:link_url />">
    <txp:link_name escape="html" />
</a> | <txp:link_category title="1" />
```

--------------------------------

### Example HTML Output of an Article Form

Source: https://docs.textpattern.com/build/form-templates-explained

Illustrates the rendered HTML output when the 'single-article-template' form is applied to an article.

```html
<article>
    <h1>My article title</h1>
    <p class="published">4 May 2016</p>
    <p>The full body of the article text.</p>
</article>
```

--------------------------------

### Display a Search Input Form

Source: https://docs.textpattern.com/tags/search_input

Example of displaying a search input form with a label, button, and specified size. Use this for a standard search interface.

```textpattern
<txp:search_input label="Search" button="Search" size="20" wraptag="div" />
```

--------------------------------

### Nested Textpattern Tags Example

Source: https://docs.textpattern.com/tags/learning

Demonstrates correct nesting of tags, ensuring they are closed in the reverse order they were opened. This is crucial for complex layouts.

```textpattern
<txp:if_section name="archive">
    <txp:if_category>
        Category list within the archive section
    <txp:else />
        Not a category list
    </txp:if_category>
<txp:else />
    Some other section
</txp:if_section>


```

--------------------------------

### Directory Structure for Multiple Textpattern Versions

Source: https://docs.textpattern.com/setup/multi-site-installation

Shows the directory organization when running multiple Textpattern versions concurrently, with separate installations side-by-side.

```text
sites/
    mydomain/
        admin/
        private/
        public/
    yourdomain/
        admin/
        private/
        public/
    otherdomain/
        admin/
        private/
        public/
textpattern_previous/
textpattern_latest/

```

--------------------------------

### Textpattern Shortcode Usage Examples

Source: https://docs.textpattern.com/tags/shortcodes/image-with-caption-shortcode

Demonstrates various ways to use the custom 'figure' shortcode with different attributes like id, class, and caption.

```textpattern
<txp::figure id="130" />
```

```textpattern
<txp::figure id="130" class="photo" />
```

```textpattern
<txp::figure id="130" class="photo" caption="The throne of Zeus at Mount Olympus." />
```

--------------------------------

### Image URL with Specific ID and No Link

Source: https://docs.textpattern.com/tags/image_url

Example of using the image_url tag to get the URL for a specific image ID (21 and 22) for use in an img tag's src and srcset attributes, with linking disabled.

```html
<img alt="<txp:image_info id="21" type="alt" />"
    src="<txp:image_url id="21" link="0" />"
    srcset="<txp:image_url id="22" link="0" /> 2x,
            <txp:image_url id="21" link="0" /> 1x">
```

--------------------------------

### Define Document Language with lang Tag

Source: https://docs.textpattern.com/tags/lang

This example shows how to use the lang tag within the HTML 'lang' attribute to declare the document's language. It also uses the text tag to get the language direction.

```html
<!DOCTYPE html>
<html lang="<txp:lang />" dir="<txp:text item = "lang_dir" />">
<head>
    <meta charset="utf-8">
    <title>
        <txp:page_title />
    </title>
</head>

```

--------------------------------

### Hiawatha Virtual Host Configuration for Textpattern

Source: https://docs.textpattern.com/setup/configuring-a-web-server

Configure Hiawatha to serve Textpattern using PHP-FPM. Replace example.com with your domain and adjust paths as needed. Use PHP5 if PHP7 is not supported. Uncomment TLSCertFile for HTTPS and RequireTLS to enforce it.

```hiawatha
VirtualHost {
  Hostname = example.com
  StartFile = index.php
  UseFastCGI = PHP7
  UseToolkit = textpattern
  WebsiteRoot = /var/www/example.com/public
  AccessLogfile = /var/log/hiawatha/example.com/access.log
  ErrorLogfile = /var/log/hiawatha/example.com/errors.log
  #TLSCertFile = example-site.pem
  #RequireTLS = yes
}
```

--------------------------------

### Configure RewriteBase for Subdirectory Installation

Source: https://docs.textpattern.com/faqs/clean-urls-do-not-work

Use this setting in your .htaccess file when Textpattern is installed in a subdirectory.

```apache
RewriteBase /mydir/

```

--------------------------------

### Calling Greeting Form with Attributes

Source: https://docs.textpattern.com/tags/output_form

Shows how to call the 'hello' form using shortcode syntax, passing attributes that populate the `<txp:yield />` tags within the form.

```textpattern
<txp::hello who="guest" wraptag="p" class="greeting" />


```

--------------------------------

### Commented RewriteBase Example

Source: https://docs.textpattern.com/faqs/clean-urls-do-not-work

This is an example of a commented-out RewriteBase directive in an .htaccess file. Uncomment and modify as needed.

```apache
#RewriteBase /relative/web/path/

```

--------------------------------

### Example: Download File by ID with Name and Size

Source: https://docs.textpattern.com/tags/file_download_link

Creates a download link for a specific file (identified by ID 4), displaying its name and size. This snippet utilizes the file_download_name and file_download_size tags.

```textpattern
<txp:file_download_link id="4">
    <txp:file_download_name />
    [<txp:file_download_size format="mb" decimals="2" />]
</txp:file_download_link>
```

--------------------------------

### Display Link and Author

Source: https://docs.textpattern.com/tags/link_author

Example demonstrating how to display a link and its associated author's name using txp:link and txp:link_author tags within a paragraph.

```textpattern
<p>
    <txp:link />
    <br />
    <txp:link_author />
</p>
```

--------------------------------

### Configure RewriteBase for Root Installation

Source: https://docs.textpattern.com/faqs/clean-urls-do-not-work

Use this setting in your .htaccess file when Textpattern is installed in the website's root directory.

```apache
RewriteBase /

```

--------------------------------

### Comment Form Example

Source: https://docs.textpattern.com/tags/comment_submit

A complete example of a comment form using various Textpattern comment tags, including the comment_submit tag.

```textpattern
<p>
    Name (required)<br />
    <txp:comment_name_input />
</p>
<p>
    Email (required)<br />
    <txp:comment_email_input />
</p>
<p>
    Website<br />
    <txp:comment_web_input />
</p>
<p>
    <txp:comment_remember />
</p>
<p>
    Message (required)<br />
    <txp:comment_message_input /><br />
    <txp:comments_help />
</p>
<p>
    <txp:comment_preview />
    <txp:comment_submit />
</p>
```

--------------------------------

### Example: Identify Last Category in a List

Source: https://docs.textpattern.com/tags/if_last_category

This example demonstrates how to use if_last_category to conditionally format the last category in a category list, preventing it from being hyperlinked.

```textpattern
<txp:category_list parent="group-1" children="0">
    <txp:if_last_category>
        <h3>
            <txp:category />
        </h3>
    <txp:else />
        <txp:category link="1" />
    </txp:if_last_category>
</txp:category_list>


```

--------------------------------

### Prompt User for Login

Source: https://docs.textpattern.com/tags/password_protect

Use this example to cause Textpattern to immediately prompt the user for a username and password. Note that this method is not adequate for protecting single sections due to Textpattern's URL handling.

```textpattern
<txp:password_protect login="theusername" pass="thepassword" />
```

--------------------------------

### PHP Info Check

Source: https://docs.textpattern.com/setup/configuring-a-web-server

Use this snippet to create a preflight check file to confirm PHP and MySQL are functioning correctly before installing Textpattern. Delete the file after verification.

```php
<?php phpinfo(); ?>
```

--------------------------------

### Plugin Development Workflow

Source: https://docs.textpattern.com/development/plugin-template-help

This snippet shows the typical command-line steps to copy, edit, and compile a Textpattern plugin using the template.

```bash
$ cp zem_plugin.php abc_myplugin.php
[edit abc_myplugin.php]
$ php abc_myplugin.php > abc_myplugin-0.1.txt
```

--------------------------------

### Comment Display Form Example

Source: https://docs.textpattern.com/tags/comment_message

An example of how to use the comment_message tag within a comment display form. It shows the comment message and links for email and permalink.

```textpattern
<txp:comment_message />
<p class="footnote">
    <a href="mailto:<txp:comment_email />">Email</a> |
    <txp:comment_permlink>
        <txp:comment_id />
    </txp:comment_permlink>
</p>
```

--------------------------------

### Display and Link File Author

Source: https://docs.textpattern.com/tags/file_download_author

Example demonstrating how to display the file author's name and make it a clickable link. The 'link' attribute is set to '1' to enable the hyperlink.

```html
<p>
    File author:
    <txp:file_download_author link="1" />
</p>
```

--------------------------------

### Plugin Help Template

Source: https://docs.textpattern.com/development/plugin-user-help-guidelines

This is the complete template for plugin help files. Copy and paste it into your editor, then remove any unnecessary sections.

```textile
h1. prefix_plugin_name

p. A brief summary of what the plugin does.

p. *Version:* current version number goes here.

h2. List of features

* Feature 1
* Feature 2
* Feature 3

h2. Minimum requirements

p. This plugin has the following minimum requirements (and/or dependencies):

* Textpattern 4.x
* Plugin dependency 1
* Plugin dependency 2

h2. Installation

p. Any special installation instructions.

h2. Uninstallation

p. Any special uninstallation instructions.

h2. Plugin tags

h3. prefix_tag_name1

p. Description of the plugin tag and how it is intended to be used.

p. %attribute_name% %value_type%
Description of the attribute usage.

p. %attribute_name% %value_type%
Description of the attribute usage.

h3. prefix_tag_name2

p. Description of the plugin tag and how it is intended to be used.

p. %attribute_name% %value_type%
Description of the attribute usage.

p. %attribute_name% %value_type%
Description of the attribute usage.

h2. Exposed functions

h3. my_plugin_func

p. This function will do foo or bar.

p. %(atts-name)Return Value% %(atts-type)return_value_type%
Description of the function return value.

p. %arg_name% %arg_value_type%
Argument description.

h2. Plugin events

h3. my_plugin.event

p. This event is called when blah happens.

h2. Examples

h3. Example 1

p. A large example that puts it all together or examples to go with each tag (in which case it is probably better to include it with the tag above).

bc. Example code

h3. Example 2

p. A large example that puts it all together or examples to go with each tag (in which case it is probably better to include it with the tag above).

bc. Example code

h2. Licence

p. State any special license information here.

h2. Author contact

p. Developer contact details, or links to where one can get more help or make suggestions.

```

--------------------------------

### Popup Comments Form Template Example

Source: https://docs.textpattern.com/tags/popup_comments

An example of an HTML structure for a popup comments form template. It includes basic HTML, head, and body elements, along with Textpattern tags for page title and CSS.

```html
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>
        <txp:page_title />
    </title>
    <meta name="generator" content="Textpattern CMS">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <meta name="robots" content="noindex, follow">
    <txp:css format="link" media="" />
</head>
<body class="popup-page">
    <div class="container">
        <txp:popup_comments />
    </div>
</body>
</html>

```

--------------------------------

### Display Link with Date and Class

Source: https://docs.textpattern.com/tags/link_date

This example shows how to display a link's name and its creation date, applying a CSS class to the link. It utilizes link_url, link_name, and link_date tags.

```html
<a class="awesome-links" href="<txp:link_url />">
    <txp:link_name escape="html" />:
</a>
(<txp:link_date />)
```

--------------------------------

### Example: Using meta_keywords for Meta Tag

Source: https://docs.textpattern.com/tags/meta_keywords

This example shows the meta_keywords tag used in a template's head section to output keywords as meta tag content. If keywords are 'sauce, caramel, sugar', it generates the corresponding meta tag.

```html
<txp:meta_keywords />
```

```html
<meta name="keywords" content="sauce,caramel,sugar" />
```

--------------------------------

### Textpattern Tag Trace Output Example

Source: https://docs.textpattern.com/installation/troubleshooting-textpattern

This is an example of the detailed output generated by Textpattern's Tag Trace when debugging mode is enabled. It includes summary statistics, a trace log of tag and PHP execution, and a query log of database operations.

```text
<!-- Trace summary:
Runtime   : 198.67 ms
Query time: 44.58 ms
Queries   : 25
Memory (*): 7644 kB
-->

<!-- Trace log:
  Time(ms) | Duration | Trace
      3.55 |     2.51 | [PHP includes, stage 1]
      6.27 |    13.15 | [PHP includes, stage 2]
      6.55 |          | 	[Textpattern autoload dir: 'vendors']
      6.64 |          | 	[Textpattern autoload dir: 'lib']
     16.28 |     0.41 | 	[Load: 'vendors/Txp.php']
     16.55 |     0.10 | 		[Load: 'vendors/Textpattern/Container/FactoryInterface.php']
     16.69 |          | 		[Class loaded: 'Txp']
…
     46.85 |   123.46 | [Loading plugins]
…
    176.02 |     0.40 | [SQL: SELECT page, css FROM txp_section WHERE name = 'default' LIMIT 1 ]
    176.43 |          | [Rows: 1]
    176.59 |     0.02 | [Callback_event: 'pretext_end', step='', pre='0']
    176.73 |     0.01 | [Callback_event: 'log_hit', step='', pre='0']
    176.75 |     0.01 | [Callback_event: 'textpattern', step='', pre='0']
    176.80 |     0.45 | [SQL: SELECT user_html FROM txp_page WHERE name = 'default' ]
    177.26 |          | [Rows: 1]
    177.27 |          | [Page: 'default']
    177.90 |     0.14 | <txp:meta_author title="1" />
    178.05 |     0.04 | <txp:page_title />
    178.10 |     0.32 | <txp:meta_description />
    178.15 |     0.24 | 	[SQL: SELECT description FROM txp_section WHERE name = 'default' ]
    178.40 |          | 	[Rows: 1]
    178.43 |     0.01 | <txp:site_url />
    178.71 |     1.70 | <txp:rvm_css format="link" />
    178.76 |     0.21 | 	[SQL: SELECT css FROM txp_section WHERE name='default' ]
    178.98 |          | 	[Rows: 1]
    179.01 |     0.01 | 	[Callback_event: 'sanitize_for_url', step='', pre='0']
…
    195.21 |     0.02 | 	<txp:if_first_article>
    195.22 |          | 		[false]
    195.23 |          | 	</txp:if_first_article>
    195.23 |     0.17 | 	<txp:permlink>
*   195.28 |     0.10 | 		<txp:title />
    195.41 |          | 	</txp:permlink>
    195.41 |     0.05 | 	<txp:posted format="%Y-%m-%d" />
…
    198.59 |          | [ ~~~ secondpass ~~~ ]
    198.65 |     0.02 | [Callback_event: 'textpattern_end', step='', pre='0']
-->

<!-- Query log:
Duration | Query
   10.53 | [SQL: SELECT name, val FROM txp_prefs WHERE prefs_id = 1 AND user_name = '' ]
    9.85 | [SQL: SELECT name, data FROM txp_lang WHERE lang = 'en-gb' AND name != '' AND event IN ('public','common') ]
   11.24 | [SQL: SELECT name, code, version FROM txp_plugin WHERE status = 1 AND type IN (0,1,5) ORDER BY load_order ASC, name ASC ]
    0.40 | [SQL: SELECT page, css FROM txp_section WHERE name = 'default' LIMIT 1 ]
    0.45 | [SQL: SELECT user_html FROM txp_page WHERE name = 'default' ]
    0.24 | [SQL: SELECT description FROM txp_section WHERE name = 'default' ]
    0.21 | [SQL: SELECT css FROM txp_section WHERE name='default' ]
    0.31 | [SQL: SELECT name FROM txp_section WHERE on_frontpage != '1' ]
    1.62 | [SQL: SELECT COUNT(*) FROM textpattern WHERE 1 = 1 AND Status = 4 AND Posted <= from_unixtime(1591515914) ]
    0.74 | [SQL: SELECT *, UNIX_TIMESTAMP(Posted) AS uPosted, UNIX_TIMESTAMP(Expires) AS uExpires, UNIX_TIMESTAMP(LastMod) AS uLastMod FROM textpattern WHERE 1 = 1 AND Status = 4 AND Posted <= from_unixtime(1591515914) ORDER BY Posted DESC LIMIT 0, 10 ]
    0.47 | [SQL: SELECT Form FROM txp_form WHERE name = 'article_listing' ]
…
```

--------------------------------

### Display Next Link in Site Language

Source: https://docs.textpattern.com/tags/link_to_next

This example displays the text 'Next' in the current site's language, ensuring proper internationalization. It also uses showalways="1" to always display the link.

```textpattern
<txp:link_to_next showalways="1">
    <txp:text item="next" />
</txp:link_to_next>
```

--------------------------------

### Identify First File in a File List

Source: https://docs.textpattern.com/tags/if_first_file

Example demonstrating how to use the if_first_file tag within a file_download_list to identify and style the latest release (the first file).

```textpattern
<txp:file_download_list limit="0" break="" wraptag="ul" sort="created desc">
    <txp:if_first_file>
        <li class="latest">
            <txp:file_download_link>
                <txp:file_download_name /> (Latest release)
            </txp:file_download_link>
        </li>
    <txp:else />
        <li>
            <txp:file_download_link>
                <txp:file_download_name />
            </txp:file_download_link>
        </li>
    </txp:if_first_file>
</txp:file_download_list>


```

--------------------------------

### Textpattern Pages Tag Pagination Bar Example

Source: https://docs.textpattern.com/tags/pages

Example of using the 'pages' tag as a container to create a custom pagination bar. It utilizes attributes like 'pg', 'showalways', 'link', and 'evaluate' along with nested tags like 'newer', 'older', and 'yield' to construct navigation links and page numbers.

```textpattern
<txp:pages pg showalways="2" link="" evaluate="5,2,8,4,6">
    <nav class="paginator" aria-label="List navigation">
        Pages:
        <txp:newer showalways><a rel="prev" href="<txp:yield item="url" />" title="Go to previous page" aria-label="Go to previous page">Previous</a></txp:newer>
        <ul class="pagination">
            <txp:newer shift><li><a href="<txp:yield item="url" />" title="Go to page <txp:yield item="page" />" aria-label="Go to page <txp:yield item="page" />"><txp:yield item="page" /></a></li></txp:newer>
            <txp:newer shift="-2"><li role="separator" title="More pages" aria-label="More pages">…</li></txp:newer>
            <txp:newer total shift="2"><li><a href="<txp:yield item="url" />" title="Go to page <txp:yield item="page" />" aria-label="Go to page <txp:yield item="page" />"><txp:yield item="page" /></a></li></txp:newer>
            <txp:pages><li class="current"><b title="Current page" aria-current="page"><txp:yield item="page" /></b></li></txp:pages>
            <txp:older total shift="2"><li><a href="<txp:yield item="url" />" title="Go to page <txp:yield item="page" />" aria-label="Go to page <txp:yield item="page" />"><txp:yield item="page" /></a></li></txp:older>
            <txp:older shift="-2"><li role="separator" title="More pages" aria-label="More pages">…</li></txp:older>
            <txp:older shift><li><a href="<txp:yield item="url" />" title="Go to page <txp:yield item="page" /> (last page)" aria-label="Go to page <txp:yield item="page" /> (last page)"><txp:yield item="page" /></a></li></txp:older>
        </ul>
        <txp:older showalways><a rel="next" href="<txp:yield item="url" />" title="Go to next page" aria-label="Go to next page">Next</a></txp:older>
    </nav>
</txp:pages>
```

--------------------------------

### Home Page Link with Site Name

Source: https://docs.textpattern.com/tags/link_to_home

This example shows how to use the link_to_home tag as a container for the site_name tag, creating a link to the home page that displays the site's name.

```textpattern
<txp:link_to_home>
    <txp:site_name />
</txp:link_to_home>

```
```

--------------------------------

### Ordered List Example

Source: https://docs.textpattern.com/development/plugin-user-help-guidelines

Use '#' for ordered lists in Textpattern plugin help pages.

```textile
# A number list example
# Item 2
# Item 3

```

--------------------------------

### Unordered List Example

Source: https://docs.textpattern.com/development/plugin-user-help-guidelines

Use '*' for unordered (bullet) lists in Textpattern plugin help pages.

```textile
* A bullet list example
* Item 2
* Item 3

```

--------------------------------

### Link to Previous Article

Source: https://docs.textpattern.com/tags/prev_title

This example shows how to create a link to the previous article using the 'prev_title' tag for the link text and 'link_to_prev' for the URL. Ensure 'link_to_prev' is used correctly for the URL.

```textpattern
<a href="<txp:link_to_prev />">
    <txp:prev_title />
</a>
```

--------------------------------

### Display Site Slogan in Heading

Source: https://docs.textpattern.com/tags/site_slogan

Example of how to display the site slogan within an HTML heading element.

```html
<h2>
    <txp:site_slogan />
</h2>

```

--------------------------------

### Display Image Information with Date

Source: https://docs.textpattern.com/tags/image_date

This example shows how to display additional image information, including the caption, author, and upload date, within an image gallery. The date is formatted to show the day, abbreviated month, and year.

```textpattern
<txp:images category="mammals">
    <a href="<txp:image_url />">
        <txp:thumbnail />
    </a>
    <div class="img-info">
        <txp:image_info type="caption, author" break=" by " />
        <txp:image_date format="%e %b %Y" />
    </div>
</txp:images>
```

--------------------------------

### Checkout Git Branch

Source: https://docs.textpattern.com/development/textpattern-source-code-repositories

Switch to a specific experimental or development branch within your local Textpattern repository.

```bash
$ git checkout name-of-branch

```

--------------------------------

### Display Site Name in Heading

Source: https://docs.textpattern.com/tags/site_name

Example of how to display the site's name within an H1 tag.

```html
<h1>
    <txp:site_name />
</h1>

```

--------------------------------

### Using Output Form for Static Text

Source: https://docs.textpattern.com/tags/output_form

Manage small, static text elements like copyright notices by defining them in a 'misc' form and calling it with output_form.

```textpattern
<txp:output_form form="copyright" />
```
Tokens:
Raw