Differences

This shows you the differences between two versions of the page.

--- admin_menu:page_modules:start [2008/11/11 18:30]
james
+++ admin_menu:page_modules:start [2014/09/25 16:55] (current)
@@ Line 2: / Line 2: @@
 ====== Page Modules ======
-Page Modules are the "bells & whistles" of  your site. However, even if you are not using a single Page Module, your site will run perfectly fine, so long as you have the (!MAINBODY!) tag included within your html templates. If you want to insert some additional functionality for your visitors to use, you can do so by using these optional modules. There are a wide variety of modules to choose from and each has its own specific functionality.
+Page Modules are the "bells & whistles" of our auction and classified ad software. However, even if you are not using a single Page Module, your site will run perfectly fine, so long as you have the {body_html} tag included within your html templates excepting the front page template as there is no "body html" functionality on that page. If you want to insert some additional functionality for your visitors to use, you can do so by using these optional modules. There are a wide variety of modules to choose from and each has its own specific functionality.
-To have a module show up on a page you will need to place the desired module’s (!...!) tag into the html template associated with that page. Each module's placement tag is immediately under the name of that module in the PAGE MODULES admin tool.  Wherever you place that tag in the html is the location that the functionality associated with that tag will show up on the page. Each module’s tag can be identified by a similar module name that has brackets around it and is displayed just below the module name on the main Modules Page.
+To have a module show up on a page you will need to place the desired module’s {...} tag into the html template associated with that page. Each module's placement tag is immediately under the name of that module in the PAGE MODULES admin tool.  Wherever you place that tag in the html is the location the functionality associated with that tag will show up on the page. Each module’s tag can be identified by a similar module name that has brackets around it and is displayed just below the module name on the main Modules Page.
-After inserting each desired tag into the appropriate html template(s), you will then need to "attach" that module to the page(s) that use the html template you just inserted the module into. This process is covered in more detain within the PAGE MENU section of this manual.  Please note that in most situations you will not need to attach a module to a page as page templates are "parsed" for these tags automatically when a page template is attached to a page or a page template is edited.  If any of these tags are found within the page template when that page template is attached to a page those modules are automatically attached to that page.  If a page template is edited within the page templates admin tool that page template is parsed for module tags.  Any pages that page template is attached to is then checked to make sure those page modules are attached to those pages.
+After inserting each desired tag into the appropriate page template(s), the system will automatically attach that module to any pages that that module is used on.  If a page template is edited within the page templates admin tool that page template is parsed for module tags.  Any pages that page template is attached to is then checked to make sure those page modules are attached to those pages. In previous version you needed to sometimes manually do this.
-Also note that you can place module placement tags within html modules.  Html modules are parsed for module placement tags also.  If an html module is edited that module is parsed for module placement tags like page templates are.  After parsing the script automatically check pages to that html module is attached to to make sure the modules found within that html module are attached to those pages...and attaching if not.
+===== Deprecation of HTML Modules in v5 =====
-<tip c n>Note that the while the attachment of modules is automatic in most instances but the script WILL NOT automatically remove a page module from a page if that module's placement tag is no longer found in that pages page templates or html modules.  If you change the default design significantly or experimented with different modules within page templates/html modules when building/editing your design you may find modules attached to pages that are no longer used in those pages.  Remove any "not found" modules from pages with the possible exception of the category browsing pages if you have created category specific designs that need those "not found" modules. </tip>
+There used to be HTML modules within versions earlier than v5.  Within the v5 implementation of the Smarty template system you can create as many templates and sub-templates to use in those page templates as you want.  Within the default v5 design the head.tpl template just such a sub-template.   You can reference these sub-template within other templates by simply using Smarty terminology to include the template files where you need them.  This is how you should include those template files in other templates:
-<tip c n>Category specific templates are not parsed for module placement tags.  You will need to manually attach page modules that can only be found in category specific page designs</tip>
+<code html>{include file='sometemplatefile.tpl'}</code>
-At the bottom of each page's admin page in the PAGES MANAGEMENT admin tool you will find the modules attached to that page.  You will also find if the script has found a specific module placement tag within the html modules or page templates attached to that page.  This is a convenient way to find out if you have placed a module's placement tag properly within an html module or page template.  If "not found" and you believe you have already place a module's tag within an html module or page template check to see that you used the correct tag and/or spelled the tag correctly.  You should also remove modules you know you are not using.
+To show text only if a user is logged in or not logged in, you can use the following in any template:
-<tip c n>Please check "not found" modules attached to page in the PAGE MANAGEMENT admin tool.  Since page modules need to be manually removed from pages you may find many "not found" modules attached to pages.  If you know you are not using a module within a page remove that module from that page.  Each module that is attached to a page is "built" by the script whether found or not.  These "not found" modules could slow down the processing of the script by building unnecessary content.</tip>
+<code html>
+{if not $logged_in}
+	You are NOT Logged in!
+{else}
+	Welcome!  You are logged in!
+{/if}
+</code>
-Page modules run independently of the (!MAINBODY!) tag and have their own settings within each modules administration page. In fact, you can remove the (!MAINBODY!) tag altogether in some of your html templates and instead only use only Page Modules. Be careful, however, that you don’t unintentionally remove necessary tables or links that the user needs to navigate your site.
+===== Module Attachments =====
-One example of using Page Modules instead of the (!MAINBODY!) tag, for instance, would be if you wanted to change up the format of the front page of your site. Instead of letting the (!MAINBODY!) tag dictate where certain functions show up, you can instead use "page module" tags, and simply remove the (!MAINBODY!) tag altogether from that template. Typically, the (!MAINBODY!) tag will display "Featured Listings" and "Newest Listings" in a certain order and in a specific location on your page. If you want to change these properties, an option for you would be to implement Page Modules to call out your Featured and Newest Listings instead.
+Within each modules admin tool page you will see a section at the bottom of the page that contains all of the page templates that specific modules placement tag is found.  So if you make changes to the configuration settings for that module you can immediately see which templates will be affected by that change.  You can even go directly to the edit page for that page template by clicking the "edit template" button to the right of that template.
-Additionally, page modules have their own properties and configuration settings, independent of the "Site Setup" settings typically associated with the (!MAINBODY!) tag. To access each page module’s individual settings, click the "edit" button for that page module. If applicable, there will be text, CSS, and table properties associated with each module for you to edit.
+<tip c n>Note that page to module attachment is automatically done by the software.  But this only applies when you make template edits directly through the admin tool.  If you make changes to templates outside the software's admin tool you will occasionally need to click the **Re-Scan Attachments** button in the following admin tool for the template you are editing so that the software will re-scan that template set for module and addon placement tags.
-<tip c n> NOTE: Page module fonts, like other dynamic page fonts, are still controlled by the (!CSSSTYLESHEET!) tag, so you will need to make sure that this tag is located in the <HEAD> </HEAD> tags of your html templates using page modules.</tip>
+DESIGN > TEMPLATE SETS
+</tip>
+===== Page Module Font Controls =====
+Page module fonts, like other fonts in the system, are controlled by css documents within the system.  Most of those css controls will be included in the site wide/template set wide css document.  Some modules have their own css files and these will be included in the <head> of the page if the {header_html} tag is placed properly in the <head> </head> section of that html.  To see if the page module you are using has its own css document you can view the html source code for a client side page containing that module.  Within the <head> of that page you will see all the css documents included for the functionality/modules within the templates used on that page.  If there is a css document for a module you will see that it has the same document name as that of the module itself.  You will be able to see where that css file is within the template system and can then edit that file in the DESIGN > MANAGER admin tool.

Geodesic Solutions Community Wiki

User Tools

Site Tools

Differences

Page Tools