Custom Template Reference

From Sohowiki
(Difference between revisions)
Jump to: navigation, search
Line 35: Line 35:
  
 
'''news.html''' (OPTIONAL) - Custom blog/article display template. If found in your template folder, it will be used in place of index.html when visitor views full text of blog entry or news item.
 
'''news.html''' (OPTIONAL) - Custom blog/article display template. If found in your template folder, it will be used in place of index.html when visitor views full text of blog entry or news item.
 +
 +
==Pound Variables==
 +
'''Pound Variables:''' unique variables that tell Pro Edition where to place specific “client changeable” headers, Menu Display buttons, and automatic text menus within your layout. These are not case sensitive, and can be placed visually within your HTML editor as text, so long as they contain the pound sign.
 +
 +
<nowiki>#CONTENT#</nowiki> - Tells the system where to display the table that will hold all the content created within the Pro Edition’s Page Editor.
 +
Note: User will not be able to manage page content unless this variables is placed somewhere in your html template file (i.e. index.html).
 +
 +
<nowiki>#LOGO#</nowiki> - Replaced with data from "Template Manager > Template header line". Inserts an editable Header line that can be changed by the user via the Soholaunch Pro Edition's Template Manager feature.
 +
 +
<nowiki>#LOGOIMG#</nowiki> - Custom Logo variable added which inserts a logo which is chosen in the Template Manager Module.
 +
 +
<nowiki>#VMENU#</nowiki> - Replaced with vertical menu navigation (main and sub pages) as configured via the Menu Display module.
 +
 +
<nowiki>#HMAINS#</nowiki> - Main page links only, arranged horizontally (links managed via the Menu Display module; must set "Auto-Menu Display Type" to "Text Links").
 +
<nowiki>
 +
#VMAINS#</nowiki> - Main page links only, arranged vertically (links managed via the Menu Display module; must set "Auto-Menu Display Type" to "Text Links").
 +
 +
<nowiki>#HSUBS#</nowiki> - Sub page links only, arranged horizontally (links managed via the Menu Display module; must set "Auto-Menu Display Type" to "Text Links").
 +
 +
<nowiki>#VSUBS#</nowiki> - Sub page links only, arranged vertically (links managed via the Menu Display module; must set "Auto-Menu Display Type" to "Text Links").
 +
 +
<nowiki>#TMENU#</nowiki> - Inserts a horizontal, text based menu system that matches the “setup” of the Main and Sub menu system as configured via the Menu Display feature. Typically used for footer links.
 +
 +
<nowiki>#PAGENAME#</nowiki> - Replaces with name of current page (underscores converted into spaces).
 +
 +
<nowiki>#PAGETITLE#</nowiki> - Unique page name. Replaced with text defined via Edit Pages > Page Properties > Page Title
 +
 +
<nowiki>#USERSONLINE#</nowiki> - Replaced with the number of visitors currently browsing your website. This particular variable may be also be used within the Text Editor.
 +
 +
<nowiki>#AUTODATESTAMP#</nowiki> - Replaced the current weekday, month, day, and year.
 +
 +
<nowiki>#PROMOTXT1#/#PROMOTXT2#</nowiki> - Text variables added which inserts the first 255 characters of blog_data pulled from random blog_content entry (under special "Promo Box 1/2" blog categories)
 +
 +
<nowiki>#PROMOHDR1#/#PROMOHDR1#</nowiki> - Promo entry title. Works with --- the blog_title associated with blog_content entry pulled for <nowiki>#PROMOTXT1#/#PROMOTXT2#</nowiki>
 +
 +
<nowiki>#NEWSBOX#</nowiki> - Newsbox variable added which inserts text arranged by date, blog_title, and if desired a few lines of blog_data.
 +
 +
<nowiki>#CUSTOMINC#</nowiki> - Replaced with output of "includethis.inc" (if found), which should be placed in the template's folder along with index.html, custom.css, etc.
 +
 +
<nowiki>#CUSTOMINC2#</nowiki> - Replaced with output of "includethis2.inc" (if found), which should be placed in the template's folder along with index.html, custom.css, etc
 +
 +
  
 
==Uploading custom templates==
 
==Uploading custom templates==

Revision as of 11:09, 11 April 2006

This section covers the creation and integration of custom templates for use with the Soholaunch Pro Edition, and is intended for graphic designers and site developers. As such, a working knowledge of Adobe Photoshop and HTML programming is recommended.

Contents

How Pro Edition interprets template information

Within the maintenance platform, users will only have access to the page “content” area for editing. This means that each site must have a template design that maintains continuity throughout the site. Automatic menu generation is built in to the Soholaunch management tool so that Menu Display buttons and sub-page buttons can be defined within the template (using special Pound Variables). This gives you the option of placing Menu Display systems vertically, on the left or right of the page layout, or horizontally, across the top or bottom of your pages.

You may also wish to custom-design your main navigation system and not use the Menu Display feature at all. This allows you to have total control over font, colors and sizes of your navigation structure. For even greater flexibility in design, different templates may be assigned to individual site pages throughout your site.

Your template designs can take on any level of complexity that you wish them to have. However, please note that the user, via the management tool, cannot change any images, text, or links built into the template. This should always be planned and noted well ahead of the build process.

In order for your template to work, you will be producing a series of images and an HTML template file to be uploaded via the Pro Edition’s File Upload module.

See for detailed info


Template folder and files

Place all files(images,index.html,custom.css, etc) into a folder and name the folder like this...

    Category-Sub_Category-Color

    Example: Category-Template_Name-Color

Possible files in your template folder (aside from images):

index.html (REQUIRED) - The main HTML template file for your website used accross all site pages. This file must exist in your template folder in order for site pages to display at all.

custom.css (OPTIONAL) - If found in your template folder, it will be used in place of the default stylesheet (runtime.css).

cart.html (OPTIONAL) - Custom shopping cart template. If found in your template folder, it will be used in place of index.html on shopping cart system pages (as in: when website visitor is browsing/purchasing products via your online checkout process).

home.html (OPTIONAL) - Custom home page splash template. If found in your template folder, it will be used in place of index.html on the "Home Page".

news.html (OPTIONAL) - Custom blog/article display template. If found in your template folder, it will be used in place of index.html when visitor views full text of blog entry or news item.

Pound Variables

Pound Variables: unique variables that tell Pro Edition where to place specific “client changeable” headers, Menu Display buttons, and automatic text menus within your layout. These are not case sensitive, and can be placed visually within your HTML editor as text, so long as they contain the pound sign.

#CONTENT# - Tells the system where to display the table that will hold all the content created within the Pro Edition’s Page Editor. Note: User will not be able to manage page content unless this variables is placed somewhere in your html template file (i.e. index.html).

#LOGO# - Replaced with data from "Template Manager > Template header line". Inserts an editable Header line that can be changed by the user via the Soholaunch Pro Edition's Template Manager feature.

#LOGOIMG# - Custom Logo variable added which inserts a logo which is chosen in the Template Manager Module.

#VMENU# - Replaced with vertical menu navigation (main and sub pages) as configured via the Menu Display module.

#HMAINS# - Main page links only, arranged horizontally (links managed via the Menu Display module; must set "Auto-Menu Display Type" to "Text Links"). #VMAINS# - Main page links only, arranged vertically (links managed via the Menu Display module; must set "Auto-Menu Display Type" to "Text Links").

#HSUBS# - Sub page links only, arranged horizontally (links managed via the Menu Display module; must set "Auto-Menu Display Type" to "Text Links").

#VSUBS# - Sub page links only, arranged vertically (links managed via the Menu Display module; must set "Auto-Menu Display Type" to "Text Links").

#TMENU# - Inserts a horizontal, text based menu system that matches the “setup” of the Main and Sub menu system as configured via the Menu Display feature. Typically used for footer links.

#PAGENAME# - Replaces with name of current page (underscores converted into spaces).

#PAGETITLE# - Unique page name. Replaced with text defined via Edit Pages > Page Properties > Page Title

#USERSONLINE# - Replaced with the number of visitors currently browsing your website. This particular variable may be also be used within the Text Editor.

#AUTODATESTAMP# - Replaced the current weekday, month, day, and year.

#PROMOTXT1#/#PROMOTXT2# - Text variables added which inserts the first 255 characters of blog_data pulled from random blog_content entry (under special "Promo Box 1/2" blog categories)

#PROMOHDR1#/#PROMOHDR1# - Promo entry title. Works with --- the blog_title associated with blog_content entry pulled for #PROMOTXT1#/#PROMOTXT2#

#NEWSBOX# - Newsbox variable added which inserts text arranged by date, blog_title, and if desired a few lines of blog_data.

#CUSTOMINC# - Replaced with output of "includethis.inc" (if found), which should be placed in the template's folder along with index.html, custom.css, etc.

#CUSTOMINC2# - Replaced with output of "includethis2.inc" (if found), which should be placed in the template's folder along with index.html, custom.css, etc


Uploading custom templates

If you're running v4.8.5 or later... Zip up your Template Folder and Files and upload the .zip file via Template Manager > Upload Custom Template (below Base Site Template selection). Once uploaded the product will automatically extract your .zip file in the correct location, and the template will be availible in the list of templates (drop-downs and browse by screenshot).

If you're running a version prior to v4.8.5, or if you want to quickly update individual template files... Log-in to your site via FTP and upload your template folder (containing all template files) to this folder:

    sohoadmin/program/modules/site_templates/pages
Personal tools