Geodesic Solutions Community Wiki

User Tools

Site Tools

You are here: Auction and Classified Software Support Home » Tutorials » Design - Advanced » Make your Template Set Update Friendly
tutorials:design_adv:make_template_set_update_friendly

Differences

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

Link to this comparison view

Next revision 		Previous revision
tutorials:design_adv:make_template_set_update_friendly [2010/11/05 15:48]
jonyo created 		tutorials:design_adv:make_template_set_update_friendly [2014/09/25 16:55] (current)
Line 1: Line 1:
 +{{indexmenu_n>80}}
 ====== Make your Template Set Update Friendly ====== ====== Make your Template Set Update Friendly ======
  
-These instructions were made for sites that originally created a template set by making a full copy of the default template set((Either by creating a copy using FTP, or by using the copy button in the admin panel, or some other means)), instead of using the **Create Main Template Set** tool within the admin at **Design > Template Sets**.  If you used that tool to create your template set, then you do not need to follow these instructions, as they were already done for you by the tool.+These instructions were made for sites that originally created a template set by making a full copy of the default template set((Either by creating a copy using FTP, or by using the copy button in the admin panel, or some other means)), instead of using the **Create Main Template Set** tool within the admin at **Design > Template Sets**.  If you used that tool to create your template set, then you should not need to follow these instructions((Unless instructed to do so by Support.)), as they were already done for you by the tool.
  
-Again, I want to make it clear that these instructions are not normally needed, as they re-produce something that the software would normally do for you.  They are only needed when the steps the software does for you are accidentally bypassed.+Again, I want to make it clear that these instructions are not normally needed, as they re-produce something that the software would normally do for you.  They are only needed when the steps the software does for you are somehow accidentally bypassed.
  
   - First, make a backup of your template set so that you have a copy of all the files, in case anything goes wrong during these instructions.  You can do that in your admin panel at **Design > Template Sets**, by clicking on the **download** button next to the template set.  Or just download using FTP. <   - First, make a backup of your template set so that you have a copy of all the files, in case anything goes wrong during these instructions.  You can do that in your admin panel at **Design > Template Sets**, by clicking on the **download** button next to the template set.  Or just download using FTP. <
-  - In your template set, **delete** the following folders using FTP((These folders are relative to your custom template set, for instance **geo_templates/my_templates/** if you named your template set **my_templates**.)):+  - In your **custom** template set((Do **not** do this to the default template set!  These instructions should only be applied to your custom template set, the one you need to make "update friendly".)), **delete** the following folders using FTP((These folders are relative to your custom template set, for instance **geo_templates/my_templates/** if you named your template set **my_templates**.)):
     * system/ <     * system/ <
     * module/ <     * module/ <
Line 12: Line 13:
     * external/js/ (The JS sub-folder only, do not delete the entire external folder) <     * external/js/ (The JS sub-folder only, do not delete the entire external folder) <
 < <
-  - Inside the folder **external/css/**, delete all the files **except for theme_styles.css**. < +  - In your **custom** template set((Do **not** do this to the default template set!  These instructions should only be applied to your custom template set, the one you need to make "update friendly".)), in the folder **external/css/**, delete all the files **except for theme_styles.css, primary_theme_styles.css((If the file exists)), and secondary_theme_styles.css((If the file exists))**. < 
-  - Edit the file **external/css/theme_styles.css** and look at the top of the file.  Does the first line have something that looks like this on it?  <code css>/* $Rev:12345$ */</code>  The number will be different.  If it DOES have that line at the top, then replace the line with the below, filling in the "Rev number" in your file for # below:<code css>@import url(\'../../../default/external/css/theme_styles.css\');+  - In your **custom** template set((Do **not** do this to the default template set!  These instructions should only be applied to your custom template set, the one you need to make "update friendly".)), edit the file **external/css/theme_styles.css** and look at the top of the file.  Does the first line have something that looks like this on it?  <code css>/* $Rev:12345$ */</code>  The number will be different.  If it DOES have that line at the top, then replace the line with the below, filling in the "Rev number" in your file for # below:<code css>@import url('../../../default/external/css/theme_styles.css');
  
 /* /*
Line 21: Line 22:
  */  */
 </code> </code>
-The Rev # is just for your own reference in case you ever need to know what revision of the file was used to create the file.+<tip c h>**Note:** The most important part of what you are adding to the theme_styles.css file, is the first line, the one that starts with "@import...".  The lines below that are "CSS Comments", they do not have any affect on the actual "styles" of your website, they are there for information purposes((Hopefully the comments will keep someone from removing the line at a later date thinking it is not needed.  The Rev # that you should have copied from the "original" first line, is for your own reference in case you ever need to know what revision of the file was used to create the file.  Sometimes Support may need to know what revision the CSS file was "based" off of as well.)).</tip> 
 +< 
 +  - In your **custom** template set((Do **not** do this to the default template set!  These instructions should only be applied to your custom template set, the one you need to make "update friendly".)), look to see if you have the file **external/css/primary_theme_styles.css**.  If you do, follow step #4 above, but for the **primary_theme_styles.css** file.  In the text you replace, use this instead of what is listed in that step:<code css>@import url('../../../default/external/css/primary_theme_styles.css'); 
 + 
 +/* 
 + * Leave first line of this file intact to make software updates easier! 
 + *  
 + * File manually copied using Rev: # 
 + */ 
 +</code> 
 +< 
 +  - In your **custom** template set((Do **not** do this to the default template set!  These instructions should only be applied to your custom template set, the one you need to make "update friendly".)), look to see if you have the file **external/css/secondary_theme_styles.css**.  If you do, follow step #4 above, but for the **secondary_theme_styles.css** file.  In the text you replace, use this instead of what is listed in that step:<code css>@import url('../../../default/external/css/secondary_theme_styles.css'); 
 + 
 +/* 
 + * Leave first line of this file intact to make software updates easier! 
 + *  
 + * File manually copied using Rev: # 
 + */ 
 +</code> 
 +<
   - For most sites, you are almost finished!  If, however, you know that you have customized one of the files that you deleted in one of the steps above, you have a little more work to do.  For each system, module, or addon template you have customized:   - For most sites, you are almost finished!  If, however, you know that you have customized one of the files that you deleted in one of the steps above, you have a little more work to do.  For each system, module, or addon template you have customized:
-    - Copy the customized template back into your template set, re-creating the folder structure for the parent folders.  **Only copy customized templates!((Every system, module, or addon template that exists in your own template set, is one more thing to keep track of during updates.  The more of those templates you have customized, the more work updates will be since you will most likely need to make //compatibility changes// to some of them when you update.))** <+    - Copy the customized template back into your cleaned up custom template set, re-creating the folder structure for the parent folders.  **Only copy customized templates!((Every system, module, or addon template that exists in your own template set, is one more thing to keep track of during updates.  The more of those templates you have customized, the more work updates will be since you will most likely need to make //compatibility changes// to some of them when you update.))** <
     - If you are following these instructions after an update, check to see if the customized template needs compatibility changes for the version you have updated to.  You can find general tips for doing that in [[tutorials/design_adv/replace_system_templates#geo_updates_customized_templates|Geo Updates & Customized Templates]]. <     - If you are following these instructions after an update, check to see if the customized template needs compatibility changes for the version you have updated to.  You can find general tips for doing that in [[tutorials/design_adv/replace_system_templates#geo_updates_customized_templates|Geo Updates & Customized Templates]]. <
     - For every software update you perform in the future, you will need to [[tutorials/design_adv/replace_system_templates#geo_updates_customized_templates|keep your customizations updated]].  The //most likely// time you will need to adjust your customized templates, is during a feature release((This is not a rule, just the general rule of thumb.  There are times you may need to make adjustments in //maintenance releases//, for instance if there is a bug fixed that requires changes to the template file.)).  The linked page has more information about the "best way" to do this.     - For every software update you perform in the future, you will need to [[tutorials/design_adv/replace_system_templates#geo_updates_customized_templates|keep your customizations updated]].  The //most likely// time you will need to adjust your customized templates, is during a feature release((This is not a rule, just the general rule of thumb.  There are times you may need to make adjustments in //maintenance releases//, for instance if there is a bug fixed that requires changes to the template file.)).  The linked page has more information about the "best way" to do this.
tutorials/design_adv/make_template_set_update_friendly.1288972085.txt.gz · Last modified: 2014/09/25 16:55 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
CC Attribution-Noncommercial-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki