Skip to content

Templates

Jump to bottom
Thomas Lange edited this page Mar 14, 2022 · 16 revisions

WARNING: Parameters marked with {!} must be escaped from HTML markup if you display them!

├── html
│   ├── 403.php
│   ├── 404.php
│   ├── category
│   │   ├── item.php
│   │   ├── list.php
│   │   └── main.php
│   ├── feed
│   │   ├── item.php
│   │   └── main.php
│   ├── home.php
│   ├── main.php
│   ├── page
│   │   ├── item.php
│   │   ├── list.php
│   │   └── main.php
│   ├── pagination.php
│   ├── post
│   │   ├── item.php
│   │   ├── list.php
│   │   └── main.php
│   ├── search
│   │   ├── main.php
│   │   └── result.php
│   └── user
│       ├── item.php
│       ├── list.php
│       └── main.php
├── lang
│   ├── de.php
│   └── en.php
│   └── […]
└── rsrc
    └── […]

Global html/*

The following variables are available in each other template file:

  • $BLOGMETA['NAME']{!}: Global available: The name of the blog
  • $BLOGMETA['DESC']{!}: Global available: The description of the blog
  • $BLOGMETA['HOME']{!}: Global available: The name of the start page of the blog
  • $BLOGMETA['MAIL']: Global available: The email address of the contact person
  • $BLOGMETA['LANG']: Global available: The two-letter language code for the content

Main Template html/main.php

Basic framework of the HTML document which contains the main content:

  • $HEAD['NAME']{!}: Contains the document name for the <title> tag or something else
  • $HEAD['DESC']{!}: Contains the document description for <meta tags or something else
  • $HEAD['PERM']: Contains the canonical URL for this document
  • $HEAD['OG_IMAGES']: Contains a list of image URLs for the document
  • $HTML: Contains the documents main body (other templates)

If you are on a single category, page, post or user:

  • $TYPE: Contains either CATEGORY, PAGE, POST or USER as string value.

If $TYPE is CATEGORY:

  • $CATEGORY: [See reference for @CATEGORY]
  • $CATEGORIES: Contains a list of @CATEGORY arrays (the parents and the direct category itself)

If $TYPE is PAGE:

  • $PAGE: [See reference for @PAGE]
  • $USER: [See reference for @USER]

If $TYPE is POST:

  • $POST: [See reference for @POST]
  • $USER: [See reference for @USER]

If $TYPE is USER:

  • $USER: [See reference for @USER]

Home Template html/home.php

This is the default startpage template which contains a list with the last posts.

  • $LIST['POSTS']: Contains a list of post items for the home site
  • $PAGINATION['HTML']: Contains the pagination template with the list navigation

Category List Template html/category/list.php

Overview template which contains the site navigation and a list of category items to be displayed.

  • $LIST['CATEGORIES']: Contains a list of category items for the current site
  • $PAGINATION: [See reference for @PAGINATION]

Page List Template html/page/list.php

Overview template which contains the site navigation and a list of page items to be displayed.

  • $LIST['PAGES']: Contains a list of page items for the current site
  • $PAGINATION: [See reference for @PAGINATION]

Post List Template html/post/list.php

Overview template which contains the site navigation and a list of post items to be displayed.

  • $LIST['POSTS']: Contains a list of post items for the current site
  • $PAGINATION: [See reference for @PAGINATION]

User List Template html/user/list.php

Overview template which contains the site navigation and a list of user items to be displayed.

  • $LIST['USERS']: Contains a list of user items for the current site
  • $PAGINATION: [See reference for @PAGINATION]

Category Item Template html/category/item.php

Represents a single category to display within the list template.

  • $CATEGORY: [See reference for @CATEGORY]
  • $CATEGORIES: Contains a list of @CATEGORY arrays (the parents and the direct category itself)
  • $IS_ROOT: Boolean if this category item is in the root list or if it is a child of some category
  • $COUNT['POST']: Contains the number of posts published in this category
  • $COUNT['CHILDREN']: Contains the number of children categories

Page Item Template html/page/item.php

Represents a single page to display within the list template.

  • $PAGE: [See reference for @PAGE]
  • $USER: [See reference for @USER]

Post Item Template html/post/item.php

Represents a single post to display within the list template.

  • $POST: [See reference for @POST]
  • $USER: [See reference for @USER]
  • $CATEGORY: [See reference for @CATEGORY]
  • $CATEGORIES: Contains a list of @CATEGORY arrays (the parents and the direct category itself)

User Item Template html/user/item.php

Represents a single user to display within the list template.

  • $USER: [See reference for @USER]

Category Main Template html/category/main.php

Main template for a single category.

  • $CATEGORY: [See reference for @CATEGORY]
  • $CATEGORIES: Contains a list of @CATEGORY arrays (the parents and the direct category itself)
  • $COUNT['POST']: Contains the number of posts published in this category
  • $COUNT['CHILDREN']: Contains the number of children categories
  • $CATEGORY['PREV']: NOT IMPLEMENTED YET
  • $CATEGORY['NEXT']: NOT IMPLEMENTED YET
  • $LIST['CATEGORIES']: Contains a list of direct children categories
  • $LIST['POSTS']: Contains a list of post items in this category

Page Main Template html/page/main.php

Main template for a single page.

  • $PAGE: [See reference for @PAGE]
  • $USER: [See reference for @USER]
  • $PAGE['PREV']: Same data structure as $PAGE but with the data from the previous page
  • $PAGE['NEXT']: Same data structure as $PAGE but with the data from the next page

Post Main Template html/post/main.php

Main template for a single post.

  • $POST: [See reference for @POST]
  • $USER: [See reference for @USER]
  • $CATEGORY: [See reference for @CATEGORY]
  • $CATEGORIES: Contains a list of @CATEGORY arrays (the parents and the direct category itself)
  • $POST['PREV']: Same data structure as $POST but with the data from the previous post
  • $POST['NEXT']: Same data structure as $POST but with the data from the next post

User Main Template html/user/main.php

Main template for a single user.

  • $USER: [See reference for @USER]
  • $USER['PREV']: Same data structure as $USER but with the data from the previous user
  • $USER['NEXT']: Same data structure as $USER but with the data from the next user
  • $COUNT['POST']: Contains the number of posts published by the user
  • $COUNT['PAGE']: Contains the number of pages published by the user

Search Request Template html/search/main.php

Search template without results and with the formular.

  • $SEARCH['TEXT']{!}: Contains the full search string
  • $SEARCH['INFO']{!}: Contains a list of information messages
  • $FORM['SELECT']['D']: Contains the selected day or is empty
  • $FORM['SELECT']['M']: Contains the selected month or is empty
  • $FORM['SELECT']['Y']: Contains the selected year or is empty
  • $FORM['OPTIONS']['D']: Contains a list of possible days to select
  • $FORM['OPTIONS']['M']: Contains a list of possible months to select
  • $FORM['OPTIONS']['Y']: Contains a list of possible years to select

Search Result Template html/search/result.php

Result template with a list of posts and the formular to repeat the search.

  • $SEARCH['TEXT']{!}: Contains the full search string
  • $SEARCH['INFO']{!}: Contains a list of information messages
  • $RESULT['LIST']: Contains a list of post items as result
  • $FORM['SELECT']['D']: Contains the selected day or is empty
  • $FORM['SELECT']['M']: Contains the selected month or is empty
  • $FORM['SELECT']['Y']: Contains the selected year or is empty
  • $FORM['OPTIONS']['D']: Contains a list of possible days to select
  • $FORM['OPTIONS']['M']: Contains a list of possible months to select
  • $FORM['OPTIONS']['Y']: Contains a list of possible years to select
  • $PAGINATION: [See reference for @PAGINATION]

Pagination Template html/pagination.php

Contains the site navigation for post, page and user list (and for the home template)

  • $THIS: Contains the current site number of the list navigation
  • $LAST: Contains the last site number of the list navigation
  • $HREF: Contains the URL for a specific site number

Feed Template html/feed/main.php

Basic framework of the RSS feed in XML which contains a list of page and post items:

  • $FEED['LIST']['POSTS']: Contains a list of post items

Feed Item Template html/feed/item.php

Represents a single post to display within the feed template.

  • $POST: [See reference for @POST]
  • $USER: [See reference for @USER]
  • $CATEGORY: [See reference for @CATEGORY]
  • $CATEGORIES: Contains a list of @CATEGORY arrays (the parents and the direct category itself)

403 Template html/403.php

Default template for error page 403 Forbidden.

[no variables]

404 Template html/404.php

Default template for error page 404 Not Found.

[no variables]

References to reduce duplicate text

@CATEGORY

  • $CATEGORY['URL']: Contains the complete URL to the category content
  • $CATEGORY['ARGV']: Contains the arguments parsed as key->value array
  • $CATEGORY['FILE']['LIST']: List of extracted image URLs from the body
  • $CATEGORY['BODY']['TEXT'] (): Pre-parsed content of the category body
  • $CATEGORY['BODY']['HTML'] (): HTML parsed content of the category body
  • $CATEGORY['ATTR']['ID']: Raw attribute data from database column id
  • $CATEGORY['ATTR']['PARENT']: Raw attribute data from database column parent
  • $CATEGORY['ATTR']['SLUG']{!}: Raw attribute data from database column slug
  • $CATEGORY['ATTR']['NAME']{!}: Raw attribute data from database column name
  • $CATEGORY['ATTR']['BODY']{!}: Raw attribute data from database column body
  • $CATEGORY['ATTR']['ARGV']:{!} Raw attribute data from database column argv
  • $CATEGORY['ATTR']['TIME_INSERT']: Raw attribute data from database column time_insert
  • $CATEGORY['ATTR']['TIME_UPDATE']: Raw attribute data from database column time_update

@PAGE

  • $PAGE['URL']: Contains the complete URL to the page content
  • $PAGE['ARGV']: Contains the arguments parsed as key->value array
  • $PAGE['FILE']['LIST']: List of extracted image URLs from the body
  • $PAGE['BODY']['TEXT'] (): Pre-parsed content of the page body
  • $PAGE['BODY']['HTML'] (): HTML parsed content of the page body
  • $PAGE['ATTR']['ID']: Raw attribute data from database column id
  • $PAGE['ATTR']['USER']: Raw attribute data from database column user
  • $PAGE['ATTR']['SLUG']{!}: Raw attribute data from database column slug
  • $PAGE['ATTR']['NAME']{!}: Raw attribute data from database column name
  • $PAGE['ATTR']['BODY']{!}: Raw attribute data from database column body
  • $PAGE['ATTR']['ARGV']:{!} Raw attribute data from database column argv
  • $PAGE['ATTR']['TIME_INSERT']: Raw attribute data from database column time_insert
  • $PAGE['ATTR']['TIME_UPDATE']: Raw attribute data from database column time_update

@POST

  • $POST['URL']: Contains the complete URL to the post content
  • $POST['ARGV']: Contains the arguments parsed as key->value array
  • $POST['FILE']['LIST']: List of extracted image URLs from the body"
  • $POST['BODY']['TEXT'] (): Pre-parsed content of the post body
  • $POST['BODY']['HTML'] (): HTML parsed content of the post body
  • $POST['ATTR']['ID']: Raw attribute data from database column id
  • $POST['ATTR']['USER']: Raw attribute data from database column user
  • $POST['ATTR']['SLUG']{!}: Raw attribute data from database column slug
  • $POST['ATTR']['NAME']{!}: Raw attribute data from database column name
  • $POST['ATTR']['BODY']{!}: Raw attribute data from database column body
  • $POST['ATTR']['ARGV']:{!} Raw attribute data from database column argv
  • $POST['ATTR']['TIME_INSERT']: Raw attribute data from database column time_insert
  • $POST['ATTR']['TIME_UPDATE']: Raw attribute data from database column time_update

@USER

  • $USER['URL']: Contains the complete URL to the user
  • $USER['ARGV']: Contains the arguments parsed as key->value array
  • $USER['FILE']['LIST']: List of extracted image URLs from the body
  • $USER['BODY']['TEXT'] (): Pre-parsed content of the user body
  • $USER['BODY']['HTML'] (): HTML parsed content of the user body
  • $USER['ATTR']['ID']: Raw attribute data from database column id
  • $USER['ATTR']['SLUG']{!}: Raw attribute data from database column slug
  • $USER['ATTR']['BODY']{!}: Raw attribute data from database column body
  • $USER['ATTR']['ARGV']:{!} Raw attribute data from database column argv
  • $USER['ATTR']['USERNAME']{!}: Raw attribute data from database column username
  • $USER['ATTR']['FULLNAME']{!}: Raw attribute data from database column fullname
  • $USER['ATTR']['MAILADDR']{!}: Raw attribute data from database column mailaddr
  • $USER['ATTR']['TIME_INSERT']: Raw attribute data from database column time_insert
  • $USER['ATTR']['TIME_UPDATE']: Raw attribute data from database column time_update

@PAGINATION

  • $PAGINATION['THIS']: Contains the current site number of the list navigation
  • $PAGINATION['LAST']: Contains the last site number of the list navigation
  • $PAGINATION['HTML']: Contains the pagination template with the list navigation
Clone this wiki locally