Difference between revisions of "Themes and Templates"

From aMember Pro Documentation
Jump to: navigation, search
(Create your own theme : step by step)
Line 33: Line 33:
 
     <head>
 
     <head>
 
         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
         <title><?php echo $title ?></title>
+
         <title><?php p($title) ?></title>
 
         <?php $this->printLayoutHead(); ?>
 
         <?php $this->printLayoutHead(); ?>
 
     </head>
 
     </head>
Line 47: Line 47:
 
             <div class="am-body">
 
             <div class="am-body">
 
                 <div class="am-body-content-wrapper am-main">
 
                 <div class="am-body-content-wrapper am-main">
                     <div class="am-body-content">
+
                     <?php include $this->_script('_content.phtml'); ?>
                        <?php include $this->_script('_top.phtml'); ?>
+
                        <?php if (empty($this->layoutNoTitle)): ?>
+
                            <h1><?php echo $title ?></h1>
+
                        <?php endif; ?>
+
                        <!-- content starts here -->
+
                        <?php echo $content ?>
+
                    </div>
+
 
                 </div>
 
                 </div>
 
             </div>
 
             </div>
Line 60: Line 53:
 
         <div class="am-footer">
 
         <div class="am-footer">
 
         </div>
 
         </div>
        <?php echo $this->render('_popup.phtml'); ?>
 
 
         <?php echo $this->placeholder('body-finish'); ?>
 
         <?php echo $this->placeholder('body-finish'); ?>
 
     </body>
 
     </body>
Line 70: Line 62:
 
; <?php $this->printLayoutHead(); ?> : prints necessary header codes to HTML header
 
; <?php $this->printLayoutHead(); ?> : prints necessary header codes to HTML header
 
; <nowiki><div class="am-body"> ... </div></nowiki> : must be outside of the page where you embed aMember content
 
; <nowiki><div class="am-body"> ... </div></nowiki> : must be outside of the page where you embed aMember content
; <?php include $this->_script('_top.phtml'); ?> : includes aMember top page items like language switch, login, logout and member menu items
+
; <?php include $this->_script('_content.phtml'); ?> : displays aMember inner page content  
; <nowiki><?php if (empty($this->layoutNoTitle)): ?><h1><?php echo $title ?></h1><?php endif; ?></nowiki> : conditionally displays page title
+
; <?php echo $content ?> : most important - displays aMember inner page content  
+
 
; <?php echo $this->_scriptImg('large-alert.png'); ?> : (optionally) prints URL of image '''large-alert.png''' that you may upload to '''application/default/views/mysite/public/img/large-alert.png'''
 
; <?php echo $this->_scriptImg('large-alert.png'); ?> : (optionally) prints URL of image '''large-alert.png''' that you may upload to '''application/default/views/mysite/public/img/large-alert.png'''
  
Line 80: Line 70:
 
</source>
 
</source>
 
* '''STEP 4.''' Go to aMember Admin Control Panel -> Setup/Configuration, select "mysite" in "User Theme" dropdown and click "Save".
 
* '''STEP 4.''' Go to aMember Admin Control Panel -> Setup/Configuration, select "mysite" in "User Theme" dropdown and click "Save".
 
  
 
'''Congratulations! Your new theme has been created!''' If you open any user-side pages, you will see it uses a larger font size, and red background color. Now, that you have a good idea of how to create templates, you can start the real customization of your theme and change layout templates and CSS styles as you want. Important note - step 2 and step 3 are both optional. If you do not need layout customization, you do not need to upload the file '''layout.phtml'''; likewise, if you do not need CSS customization you do not need to upload the CSS file.
 
'''Congratulations! Your new theme has been created!''' If you open any user-side pages, you will see it uses a larger font size, and red background color. Now, that you have a good idea of how to create templates, you can start the real customization of your theme and change layout templates and CSS styles as you want. Important note - step 2 and step 3 are both optional. If you do not need layout customization, you do not need to upload the file '''layout.phtml'''; likewise, if you do not need CSS customization you do not need to upload the CSS file.

Revision as of 10:16, 25 March 2016

Contents

Templates Syntax

aMember Pro v4 uses PHP-syntax based templates, like the ones used in [Zend Framework's Zend_View] or templates used in WordPress.

Finding the templates

aMember Pro templates are located in the following folders:

application/default/views/public/img/ 
Images
application/default/views/public/css/ 
CSS files
application/default/views/public/js/ 
JavaScript libraries
application/default/views/ 
user-side templates
application/default/views/admin 
admin-side templates
application/default/themes 
user-side themes
application/default/themes-admin 
admin-side themes

Themes

aMember Pro allows you to create your own custom theme. You can copy any template, image or CSS from the application/default/views folder to your theme folder and it will override the default theme. Your custom theme will only override aMember's default theme if your theme is enabled. This is the recommended way to customize the look and feel of aMember Pro, because this way your custom theme will not be overwritten by upgrades and it is easy to determine exactly which files were modified. You need to copy to your theme folder only template files that you want to change. aMember will check template in your them folder first and if not find it then fallback to default folder.

Create your own theme : quick todo

  • Create folder amember/application/default/themes/bob/ (use only lowercase letters and digits for folder name)
  • Go to aMember CP -> Setup : enable "bob" theme
  • Create file amember/application/default/themes/bob/public/css/theme.css and looking at amember/application/default/views/public/css/reset.css and amember.css, add custom styles to the theme.css.

After each step, check the results by looking at user pages.

Create your own theme : step by step

In this quick tutorial we will describe how to create a new theme named mysite. The theme's name must be lowercase.

  • STEP 1. Using your favorite FTP client, go to folder application/default/themes/ and create folder mysite
  • STEP 2. Create an html template file layout.phtml in the mysite folder
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <title><?php p($title) ?></title>
        <?php $this->printLayoutHead(); ?>
    </head>
    <body>
        <?php echo $this->placeholder('body-start'); ?>
        <div class="am-layout">
            <a name="top"></a>
            <div class="am-header"> </div>
 
            <!-- sample image from theme folder -->
            <?php echo $this->_scriptImg('large-alert.png'); ?>
 
            <div class="am-body">
                <div class="am-body-content-wrapper am-main">
                    <?php include $this->_script('_content.phtml'); ?>
                </div>
            </div>
        </div>
        <div class="am-footer">
        </div>
        <?php echo $this->placeholder('body-finish'); ?>
    </body>
</html>

This html contains the following important elements:

<?php p($title) ?> 
prints page title to HTML header
<?php $this->printLayoutHead(); ?> 
prints necessary header codes to HTML header
<div class="am-body"> ... </div> 
must be outside of the page where you embed aMember content
<?php include $this->_script('_content.phtml'); ?> 
displays aMember inner page content
<?php echo $this->_scriptImg('large-alert.png'); ?> 
(optionally) prints URL of image large-alert.png that you may upload to application/default/views/mysite/public/img/large-alert.png
  • STEP 3. Create a file application/default/themes/mysite/public/css/theme.css and put the following lines inside your code:
body { font-size: 16pt; background-color: lightred; }
  • STEP 4. Go to aMember Admin Control Panel -> Setup/Configuration, select "mysite" in "User Theme" dropdown and click "Save".

Congratulations! Your new theme has been created! If you open any user-side pages, you will see it uses a larger font size, and red background color. Now, that you have a good idea of how to create templates, you can start the real customization of your theme and change layout templates and CSS styles as you want. Important note - step 2 and step 3 are both optional. If you do not need layout customization, you do not need to upload the file layout.phtml; likewise, if you do not need CSS customization you do not need to upload the CSS file.

Modify aMember templates if you have "Use wordpress theme" enabled

1. Create folder /amember/application/default/plugins/protect/wordpress/YOUR_WORDPRESS_THEME_FOLDERNAME

For example if you use default wordpress twentyeleven theme, create /amember/application/default/plugins/protect/wordpress/twentyeleven folder.

2. Copy layout.phtml file from /amember/application/default/plugins/protect/wordpress/default to /amember/application/default/plugins/protect/wordpress/YOUR_WORDPRESS_THEME_FOLDERNAME

3. Copy /amember/application/default/plugins/protect/wordpress/amember.php to /amember/application/default/plugins/protect/wordpress/YOUR_WORDPRESS_THEME_FOLDERNAME/amember.php

4. Edit /amember/application/default/plugins/protect/wordpress/YOUR_WORDPRESS_THEME_FOLDERNAME/layout.phtml and change this line:

include dirname(__FILE__)."/../amember.php";

to

include dirname(__FILE__)."/amember.php";

5. Make modifications to /amember/application/default/plugins/protect/wordpress/YOUR_WORDPRESS_THEME_FOLDERNAME/amember.php (which is default layout file for all aMember pages).

6. If you want to alter other amember pages or styles copy template files from /amember/application/default/views/ to /amember/application/default/plugins/protect/wordpress/YOUR_WORDPRESS_THEME_FOLDERNAME/