Functions available for user templates

You can call freely those functions from your template to create a new layout. More...

Functions

 attachmentsBox ()
 creates attachments link
 browseAllAttachmentsBox ()
 creates attachments link
 jsLinks ()
 generates javascript links so that a user can easily incorporates javascript defined in plugins
 getRootNodeLink ()
 builds a link to wiki root page

generates an anchor link pointing to wiki root page, for use in template :

 wikiMenu ()
 builds a complete wiki menu

generates an unordered list of links depending of state (user logged, global rights ...) that contain :

  • edit link
  • add content link
  • edit ACL link
  • delete node link
  • history link
  • subscribe/unsubscribe link

 contentBox ()
 display main content area

the main content area contains either the wiki content, or content based on mode (edition, search ...) It uses the global map variable $contentBoxHandle and the mode to callback a registered method that can handle the page. If no mode is found, or if no function is registered to handle current mode, the special method registered to the "default" mode is called.

 commentLink ()
 creates a comment link
 commentBox ()
 display comments
 editContentLink ()
 creates edit content link
 addContentLink ()
 creates add content link
 deleteLink ()
 creates delete link
 makeRootLink ()
 creates a "make root" link
 printLink ()
 creates a print link
 sourceLink ()
 creates a print link
 subContentBox ()
 display list of sub nodes as an unordered list
 parentContentBox ()
 display list of parent nodes as an unordered list
 phpExecutionTimeBox ()
 display time taken by script during whole execution
 sqlExecutionTimeBox ()
 display time taken by sql queries during whole execution
 contentDisplay ($showLangs=true)
 display content
 sourceDisplay ()
 display source
 navigationBox ()
 display navigation box
 editACLLink ()
 creates link to acl edition
 feedRecentCommentsUrl ()
 creates an url to recent comment feed
 feedRecentCommentsLink ()
 creates an html link to recent comment feed
 feedLocalCommentsUrl ()
 creates an html url to list of comment of current node
 feedLocalCommentsLink ()
 creates an html link to list of comment of current node
 feedRecentChangesUrl ()
 creates an html url to list of recent changes
 feedRecentChangesLink ()
 creates an html link to list of recent changes
 feedLocalChangesUrl ()
 creates an html url to history of current node
 feedLocalChangesLink ()
 creates an html link to history of current node
 feedLocalLinks ()
 return local links (history and comments of current nodes)
 historyLink ()
 creates a link to history
 loginLink ()
 creates a login link
 registerLink ()
 creates a register link
 preferencesLink ()
 creates a preferences link
 logoffLink ()
 creates a logoff link
 userMenu ()
 creates a user link as an unordered list

the menu may contain (depending on global configuration, user login ...)

  • login link
  • logged in information
  • preferences link
  • register link
  • logoff link

 metadataBox ()
 display a link to metadata
 recentChangesBox ()
 display a link to recent changes
 searchBox ($searchTerm= '')
 display a search box
 emailSubscribeLink ()
 display link to subscribe to this node
 emailUnsubscribeLink ()
 display link to unsubscribe to this node
 whatLinksHereBox ()
 display a link to the WhatLinksHere feature

return link


Detailed Description

You can call freely those functions from your template to create a new layout.

All those functions are secure. This means for example that function deleteLink() will returns a link only if current user has the right to delete a particular page.


Function Documentation

addContentLink (  ) 

creates add content link

Returns:
html link

attachmentsBox (  ) 

creates attachments link

Returns:
html link

browseAllAttachmentsBox (  ) 

creates attachments link

Returns:
html link

commentBox (  ) 

display comments

Returns:
html blob

commentLink (  ) 

creates a comment link

Returns:
html link

contentBox (  ) 

display main content area

the main content area contains either the wiki content, or content based on mode (edition, search ...) It uses the global map variable $contentBoxHandle and the mode to callback a registered method that can handle the page. If no mode is found, or if no function is registered to handle current mode, the special method registered to the "default" mode is called.

contentDisplay ( showLangs = true  ) 

display content

Parameters:
showLangs indicates if we must show lang flags or not
Returns:
html blob

deleteLink (  ) 

creates delete link

Returns:
html link

editACLLink (  ) 

creates link to acl edition

Returns:
html link

editContentLink (  ) 

creates edit content link

Returns:
html link

emailSubscribeLink (  ) 

display link to subscribe to this node

Returns:
html link

emailUnsubscribeLink (  ) 

display link to unsubscribe to this node

Returns:
html link

feedLocalChangesLink (  ) 

creates an html link to history of current node

Returns:
html link

feedLocalChangesUrl (  ) 

creates an html url to history of current node

Returns:
html url

feedLocalCommentsLink (  ) 

creates an html link to list of comment of current node

Returns:
html link

feedLocalCommentsUrl (  ) 

creates an html url to list of comment of current node

Returns:
html url

feedLocalLinks (  ) 

return local links (history and comments of current nodes)

Returns:
html url

feedRecentChangesLink (  ) 

creates an html link to list of recent changes

Returns:
html link

feedRecentChangesUrl (  ) 

creates an html url to list of recent changes

Returns:
html url

feedRecentCommentsLink (  ) 

creates an html link to recent comment feed

Returns:
html link

feedRecentCommentsUrl (  ) 

creates an url to recent comment feed

Returns:
html url

getRootNodeLink (  ) 

builds a link to wiki root page

generates an anchor link pointing to wiki root page, for use in template :

Returns:
html anchor

historyLink (  ) 

creates a link to history

Returns:
html link

jsLinks (  ) 

generates javascript links so that a user can easily incorporates javascript defined in plugins

Returns:
html links to javascript suitable for inclusion in a HEADER section

loginLink (  ) 

creates a login link

Returns:
html link

logoffLink (  ) 

creates a logoff link

Returns:
html link

makeRootLink (  ) 

creates a "make root" link

Returns:
html link

metadataBox (  ) 

display a link to metadata

Returns:
html link

navigationBox (  ) 

display navigation box

Author:
Kai Dietrich
Returns:
html navigation box (ul/li)

parentContentBox (  ) 

display list of parent nodes as an unordered list

Returns:
html unordered list

phpExecutionTimeBox (  ) 

display time taken by script during whole execution

Returns:
html paragraph

preferencesLink (  ) 

creates a preferences link

Returns:
html link

printLink (  ) 

creates a print link

Returns:
html link

recentChangesBox (  ) 

display a link to recent changes

Returns:
html link

registerLink (  ) 

creates a register link

Returns:
html link

searchBox ( searchTerm = ''  ) 

display a search box

Returns:
html blob

sourceDisplay (  ) 

display source

Returns:
html blob

sourceLink (  ) 

creates a print link

Returns:
html link

sqlExecutionTimeBox (  ) 

display time taken by sql queries during whole execution

Returns:
html paragraph

subContentBox (  ) 

display list of sub nodes as an unordered list

Returns:
html unordered list

userMenu (  ) 

creates a user link as an unordered list

the menu may contain (depending on global configuration, user login ...)

Returns:
html unordered list

whatLinksHereBox (  ) 

display a link to the WhatLinksHere feature

return link

wikiMenu (  ) 

builds a complete wiki menu

generates an unordered list of links depending of state (user logged, global rights ...) that contain :

Returns:
html unordered list


Generated on Mon Feb 19 19:11:58 2007 for Wiclear by  doxygen 1.4.7