Theia installation has been updated - September 10, 2011
Theia
Theia code reference guide « documentation » reference
icon
Please help strengthen our documentation by rating items on how helpful they are, and by suggesting documentation, that we are missing and should focus on next.
posted on 21:35 - 30 June 2009 | posted by Lev
last modified on 9:01 - 01 September 2009 | last modified by Lev

The following codes can be used within any of Theia's template files, in either the primary or secondary navigation panes, or in the section static pane. These simple codes will automatically load up the respective module or pane, though in some cases the respective module must also be enabled for anything to appear.


[LASTLOGINS]

Wherever you want to display a (vertical) pane showing the recent members to login to your site (which also supports automatic refreshing, via AJAX) simply write:

THEIA CODE

[LASTLOGINS]


[CHATTERBOX]

Wherever you want to display a (vertical) pane showing an AJAX based "chatter box" (an area where users can chit chat with a less formal setting than a chat room), simply write:

THEIA CODE

[CHATTERBOX]


[CHAT]

As well as the chatter box, Theia also comes with AJAX based chat rooms. To create a chat balloon, that says how many people are chatting, and provides a button to join in, simply write:

THEIA CODE

[CHAT]


[SECTIONLIST]

The "section list" is a (vertical) pane consisting of a menu of all your site's sections, or at least all those you have flagged to show in the menu. The list is ordered based on the section groups ordering value, and the sections in each group are ordered alphabetically. To create the section list (which is already added to your primary navigation pane on a fresh installation), just write:

THEIA CODE

[SECTIONLIST]


[CATEGORYLIST]

The "category list" is very similar to the "section list" in its appearance and usage. When used, it will display a list of all categories for the section that is currently being viewed (or the section a viewed item belongs to). It will not appear at all if no categories are present or if the SOURCE constant is not known. To add the category list, write:

THEIA CODE

[CATEGORYLIST]


[FEATUREDMEMBER]

If you want to feature members on your site, then the featured member pane is what you will want to use. It displays a pane with a member's avatar, and link to their profile. It uses the member, who has been flagged as featured, who has most recently updated their profile. More than one member can be flagged as "featured" at a time, but only the one to update their profile most recently will get displayed. You can feature a member using the member management shortcut, or by using the "feature / unfeature member" tool (admin tool 087). To display the featured member pane, write:

THEIA CODE

[FEATUREDMEMBER]


[THEMESLIST]

If you have a multi-themed site, you will probably want to give your users the ability to choose their theme. This is done by creating a small pane with a theme selection menu. To add a theme menu, write:

THEIA CODE

[THEMESLIST]


[MYSTATUS]

The "my status" feature is great for its sheer simplicity. It consists of nothing but a small area to fill in some text, mentioning what you are currently doing, thinking, or whatever you want. It updates using AJAX, so it makes a great complement everywhere on your site. To give your users a "my status" pane, write:

THEIA CODE

[MYSTATUS]


[SPOTLIGHT]

Theia's "spotlight" feature is the best way to highlight items of interest all across your site, easily. If the spotlight feature does not have any entries, it will not display. To add the spotlight pane, write:

THEIA CODE

[SPOTLIGHT]


[WHOSONLINE]

To show a short list of all the members currently on, you can create the "who's online - at a glance" pane, which shows what members are on, how many members are on, how many guests are on, and how many users are currently viewing the same page as you. This pane also has a link to the complete "who's online" page (showing everyone who's online, including guests, as well as what page they are on and when they last were active). To create the "who's online - at a glance" pane, write:

THEIA CODE

[WHOSONLINE]


[CONTENT]

If you want to show a small area listing the newest content on your site, then you can easily do this by writing:

THEIA CODE

[CONTENT]


[ASECTIONCALENDAR]

Displaying a miniature calendar, which makes the dates linkable, if at least one item was created on that day anywhere on your site, is done by writing:

THEIA CODE

[ASECTIONCALENDAR]


[SECTIONCALENDAR]

Much like the miniature calendar mentioned above, it's also possible to display a miniature calendar, which makes the dates linkable, if at least one item was created on that day in the section you are viewing (or the section for the item you are viewing). To do this, just write:

THEIA CODE

[SECTIONCALENDAR]


[POLL]

If you are using the poll system on your site, and you would like to always show a "random" poll, anywhere on your site, then this code will come in handy when used in the primary or secondary navigation panes. But it should be understood that this is not actually a "random" poll, but instead the poll which currently has been voted on the least (more likely to be a newer poll). The reason this method is used is because mySQL's rand() is quite slow, and will make a difference on a site in which many things are called by rand(). To add your own "pseudo-random" poll use this code:

THEIA CODE

[POLL]


[AD]

The ad code can be used in various ways; for more information on the different methods of using the ad code, and for information on managing your advertisement system, check out this guide. To simply call any "pseudo-random" ad, of any size, just write:

THEIA CODE

[AD]


[MEMBERS]

Fortunately, there is also an easy way to only display content (messages or even embedded modules) for clients who are logged in as registered members. To do this, you surround your text (or other Theia code) with the members code, like this:

THEIA CODE

[MEMBERS]this message is only for members[/MEMBERS]


[GUESTS]

Similarly to the members code, there is also an easy way to only display content (messages or even embedded modules) for clients who are *not* logged in. This is handy for when you want to display sign-up links, or other messages to people who aren't logging in. To do this, you surround your text (or other Theia code) with the guests code, like this:

THEIA CODE

[GUESTS]this message is only for guests[/GUESTS]

tags
post reply
Bookmark item @
bookmarkbookmarkbookmarkbookmarkbookmark