List of resource functions
The article functions
These functions are to be used in the article templates.
pxArtTitle
pxArtTitle( $s )
Parameters
- $s - Substitution string ('%s')
Display the title of the article.
pxArtDescription
pxArtDescription( )
Display the description of the article.
pxArtAuthor
pxArtAuthor( )
Display the name of the author
pxArtPath
pxArtPath( $type )
Parameters
- $type - 'full' give path with http:// ('relative')
Display the path to the article.
pxArtAuthorEmail
pxArtAuthorEmail( $s, $encoding )
Parameters
- $s - Substitution string ('%s')
- $encoding - Encoding for a mailto ('link') or for display 'text'
Display the author public email if available.
pxArtDateCreation
pxArtDateCreation( $dateformat )
Parameters
- $dateformat - Format of the date ('%A %e %B %Y')
Display the creation date of the article.
The substitution string for the date is directly given to strftime
pxArtDatePublication
pxArtDatePublication( $dateformat )
Parameters
- $dateformat - Format of the date ('%A %e %B %Y')
Display the publication date of the article.
The substitution string for the date is directly given to strftime
pxArtDateModification
pxArtDateModification( $dateformat, $s )
Parameters
- $dateformat - Format of the date ('%A %e %B %Y - %T ')
- $s - Substitution ('Modified the %s.')
Display the modification date of the article. Only if newer than the publication date.
The substitution string for the date is directly given to strftime
pxArtDateEnd
pxArtDateEnd( $dateformat, $s )
Parameters
- $dateformat - Format of the date ('%A %e %B %Y - %T ')
- $s - Substitution ('End the %s.')
Display the date of end of availaibility of the article. Only if end date.
The substitution string for the date is directly given to strftime
pxArtKeywords
pxArtKeywords( $s )
Parameters
- $s - Substitution string ('%s')
Display the keywords or subject of the article
pxArtCategories
pxArtCategories( $s, $p1, $p2 )
Parameters
- $s - Substitution string ('%s')
- $p1 - First delimiters (', ')
- $p2 - Last delimiter (' and ')
Display the list of categories in which the article is.
The list is not an HTML list, it is to be used as sentence like "Category one, category two and category tree" The category names are linked to the category pages.
pxArtPageIsFirst
pxArtPageIsFirst( )
Return true if the current page is the first, else false
pxArtPageTitle
pxArtPageTitle( $s )
Parameters
- $s - Substitution string ('%s')
Display the title of the current article page.
pxArtPageContent
pxArtPageContent( )
Display the content of the current article page.
pxArtListPages
pxArtListPages( $s )
Parameters
- $s - Substitution string ('%s')
Display an ordered list of pages in the article with link to the pages. The current page is set as active with the corresponding <li> element being from the current class.
An output example is:
<ol> <li><a href="/cat/my-article">Page 1</a></li> <li class="current"><a href="/cat/my-article2">Page 2</a></li> <li><a href="/cat/my-article3">Page 3</a></li> </ol>
The news functions
These functions are to be used in the news templates.
pxNewsTitle
pxNewsTitle( $s )
Parameters
- $s - Substitution string ('%s')
Display the title of a news.
pxNewsContent
pxNewsContent( )
Display the content of a news.
pxNewsKeywords
pxNewsKeywords( $s )
Parameters
- $s - Substitution string ('%s')
Display the keywords or subject of the news.
pxNewsDateCreation
pxNewsDateCreation( $dateformat )
Parameters
- $dateformat - Format of the date ('%A %e %B %Y')
Display the creation date of the news.
The substitution string for the date is directly given to strftime
pxNewsDatePublication
pxNewsDatePublication( $dateformat )
Parameters
- $dateformat - Format of the date ('%A %e %B %Y')
Display the publication date of the news.
The substitution string for the date is directly given to strftime
pxNewsDateModification
pxNewsDateModification( $dateformat, $s )
Parameters
- $dateformat - Format of the date ('%A %e %B %Y - %T ')
- $s - Substitution ('Modified the %s.')
Display the modification date of the news. Only if newer than the publication date.
The substitution string for the date is directly given to strftime
pxNewsDateEnd
pxNewsDateEnd( $dateformat, $s )
Parameters
- $dateformat - Format of the date ('%A %e %B %Y - %T ')
- $s - Substitution ('End the %s.')
Display the date of end of availaibility of the news. Only if end date.
The substitution string for the date is directly given to strftime
pxNewsAuthor
pxNewsAuthor( )
Display the name of the author
pxNewsAuthorEmail
pxNewsAuthorEmail( $s, $encoding )
Parameters
- $s - Substitution string ('%s')
- $encoding - Encoding for a mailto ('link') or for display 'text'
Display the author public email if available.
pxNewsPath
pxNewsPath( $type )
Parameters
- $type - 'full' give path with http:// ('relative')
Display the path to the news.
pxNewsCategories
pxNewsCategories( $s, $p1, $p2 )
Parameters
- $s - Substitution string ('%s')
- $p1 - First delimiters (', ')
- $p2 - Last delimiter (' and ')
Display the list of categories in which the news is.
The list is not an HTML list, it is to be used as sentence like "Category one, category two and category tree" The category names are linked to the category pages.
Share your ideas about this article.
