Help15

Difference between revisions of "Screen.templates.15"

From Joomla! Documentation

m
m (→‎Related Information: category reorganizing)
 
(68 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 +
==How to Access==
 +
Select '''Extensions → Template Manager''' from the drop-down menu in the back-end of your Joomla! installation.
 +
 
==Description==
 
==Description==
−
{{Help screen description placeholder}}
+
The Template Manager is where you assign a default Template to your Joomla! web site. You can also edit and preview Templates here.
 +
 
 +
In Joomla!, the visual layout of both the Front-end and Back-end of your site is controlled by the Template. Templates are extensions that contain layout and style information that tells Joomla! exactly how to draw each page of your site.
 +
 
 +
When you first install Joomla!, one Back-end Template and two Front-end templates are included. Other Templates can be installed from third-party developers as Extensions.
 +
 
 +
If you want to use the same Template for all of the pages on your site, you just assign one Template as the Default Template. You can also assign different Templates to different pages.
 +
 
 +
==Screenshot==
 +
[[Image:Template_manager.png]]
 +
 
 +
==Column Headers==
 +
{{colheader|Number}}
 +
{{colheader|Template name}}
 +
{{colheader|Default}}
 +
{{colheader|Assigned}}
 +
{{colheader|Version}}
 +
{{colheader|Extension Date}}
 +
{{colheader|Extension Author}}
 +
{{colheader|Display}}
 +
 
 +
==Toolbar==
 +
At the top right you will see the toolbar:
 +
 
 +
[[Image:Template_manager_toolbar.png]]
 +
*'''Default.''' Select the Template that you want to be the default Template. Then click this button. The default star symbol will show in the Default column, indicating that this is now the default Template.
 +
{{toolbaricon|Edit}} See the section below called [[#Template - Edit|Template - Edit]] for information on the edit screen.
 +
{{toolbaricon|Help}}
 +
 
 +
==Site and Administrator Links==
 +
At the top left, above the columns, you will see two links as shown below:
 +
 
 +
[[Image:Template_manager_links.png]]
 +
*'''Site.''' Shows the Templates available for the Front-end of the web site.
 +
*'''Administrator.''' Shows the Templates available for the Back-end of the web site. These Templates will control the appearance of the administrator portion of the site.
  
−
==Version Changes==
+
==Template - Edit==
−
{{Help screen version changes placeholder}}
+
===How to Access===
 +
Navigate to the Template Manager. Then click on the Template's name or select a Template and click the Edit icon on the toolbar.
  
−
==Unique Column Headers: Common Column Headers==
+
===Description===
−
Enter details of any specific Column Headers definitions that are unique to this function alone. Do not include this section if not applicable. There is no need to go into major detail in this section unless it is appropriate to do so. Use your judgement or discuss with other team members. Use definition term (dt) and style (dt15) for the name of the Column Header and definition description (dd) and style (dd15) for the explanation of the term.
+
This is where you can preview a Template, edit a Template's HTML and CSS files, and set parameters for a Template.
  
−
==Typical Usage==
+
===Screenshot===
−
This is the most important new section in these Help Screens. This is the meat on the bones of the Help Screen. This should represent the typical basic usage of the screens' functionality in normal use. Write it as a guide not just as a sequence of instructions - except when this is required. Include links to other screens that are needed to complete the function effectively. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.
+
[[Image:Template_edit.png]]
 +
 
 +
===Details===
 +
*'''Name.''' The Template Name. No entry is allowed.
 +
*'''Description.''' A description of the Template. No entry is allowed.
 +
*'''Menus.''' If the Template is not the default Template, you can assign it to specific Menu Items. To select multiple Menu Items,hold down the Ctrl key while clicking with the mouse.
 +
 
 +
'''Parameters'''
 +
 
 +
Some Templates have parameters that allow you to change the way the web site will look. For example, the default rhuk_milkyway template allows you to choose a foreground color, a background color, and different Template widths. Other Templates may have different or no parameters.
 +
 
 +
===Toolbar===
 +
At the top right you will see the toolbar:
 +
 
 +
[[Image:Template_edit_toolbar.png]]
 +
*'''Preview.''' Opens a preview window of your web site using this Template. This window shows the available Module Positions ("top", "left", and so on) indicated in red type. This is shown in the screenshot below:
 +
[[Image:Template_edit_preview.png]]
 +
:'''Note:''' The preview of an administrator template does not show you the administrator module positions.
 +
*'''Edit HTML.''' Opens the "index.php" file from the Template for editing using a simple text editor. Press Save or Apply to save any changes you make. Press Cancel to cancel any changes. You can also edit this file outside of Joomla! with any HTML editor. Note that the full name of this file is displayed above the edit window.
 +
*'''Edit CSS.''' Opens a list of the CSS files used in this Template. To open one of the CSS files for editing, select the file and press the Edit icon in the toolbar. This will open this CSS file for editing using a simple text editor. Press Save or Apply to save any changes you make. Press Cancel to cancel any changes. You can also edit this file outside of Joomla! with any editor. Note that the full name of this file is displayed above the edit window.
 +
{{toolbaricon|Save}}
 +
{{toolbaricon|Apply}}
 +
{{toolbaricon|Close}}
 +
{{toolbaricon|Help}}
  
 
==Quick Tips==
 
==Quick Tips==
−
Using the analogy of the previous section this is the sauce and condiments that go with the meat! Provide any one liners that may not normally be obvious. These may already be known to you or you may spot something within the forums or other publications. Just ensure they work and that the wording is consistent with the rest of the document and not a straight copy of the content from other sources. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.
+
*'''Important''': Do not delete the default template files using FTP because it generates an error in both the front-end and back-end!
 +
 
 +
*Before editing the '''HTML''' and the '''CSS''' file of the template, it is a good idea to make a backup of the file you are editing. Also, you can edit these files outside of Joomla! using the HTML or CSS editor of your choice.
 +
 
 +
*The '''Preview''' will only display positions that contain published modules. To make sure you can see all positions defined in the template, you can create custom modules for them.
 +
 
 +
*You cannot assign the default template to specific Menu Items. This is because it is already assigned to all Menu Items by default.
  
−
==Points to Watch==
+
==Related Information==
−
Highlight known issues or easy traps that can be fallen into when using this function. Include references to known solutions rather than repeating the solutions here, unless considered essential. Even if there are none immediately apparent leave this section in the Help Screen - this message for future reference. Just replace this message with None Known at this Time. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.
+
*To install a new Template: [[screen.installer.15#Install Screen|Extension Manager - Install Screen]]
 +
*To uninstall a Template: [[screen.installer.15#Templates Screen|Extension Manager - Templates Screen]]
  
−
==Dependencies==
+
<noinclude>{{cathelp|1.5|Template Manager Help Screens|Extensions Help Screens}}</noinclude>
−
Describe other screens that rely on the presence of this function or that this function relies upon, in order to work correctly for example: a Category depends upon the presence of a Section (up) and it must be in place before a Categorised Article (down) can be created. If there are no Dependencies either up or down for the particular screen just state None but do include the section. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices. It will probably be sufficient to just list these and provide links to the Help Screens relating to the dependency.
 

Latest revision as of 22:22, 4 August 2012

How to Access[edit]

Select Extensions → Template Manager from the drop-down menu in the back-end of your Joomla! installation.

Description[edit]

The Template Manager is where you assign a default Template to your Joomla! web site. You can also edit and preview Templates here.

In Joomla!, the visual layout of both the Front-end and Back-end of your site is controlled by the Template. Templates are extensions that contain layout and style information that tells Joomla! exactly how to draw each page of your site.

When you first install Joomla!, one Back-end Template and two Front-end templates are included. Other Templates can be installed from third-party developers as Extensions.

If you want to use the same Template for all of the pages on your site, you just assign one Template as the Default Template. You can also assign different Templates to different pages.

Screenshot[edit]

Template manager.png

Column Headers[edit]

  • #. An indexing number automatically assigned by Joomla! for ease of reference.
  • Template Name. The name given to each Template by the Template author. Click the Name to open the Template for editing. If you hover the mouse over the Template Name, a small preview for the Template displays in a pop-up window. The Template Name normally corresponds to the sub-directory name that contains the Template in the <path-to-Joomla!>/templates/ directory. For example, the files for the "rhuk_milkyway" Template are in the directory "<path-to-Joomla!>/templates/rhuk_milkyway".
  • Default. Indicator of Default Template.
  • Assigned. Shows whether this Template has been assigned to any specific menu items. To assign a template to menu items, open the Template for editing.
  • Version. The version number of the Extension.
  • Date. The date this extension was released.
  • Author. The author of this extension.
  • Display #. The number of items to display on one page. If there are more items than this number, you can use the page navigation buttons (Start, Prev, Next, End, and page numbers) to navigate between pages. Note that if you have a large number of items, it may be helpful to use the Filter options, located above the column headings, to limit which items display (where applicable).

Toolbar[edit]

At the top right you will see the toolbar:

Template manager toolbar.png

  • Default. Select the Template that you want to be the default Template. Then click this button. The default star symbol will show in the Default column, indicating that this is now the default Template.
  • Edit. Select one item and click on this button to open it in edit mode. If you have more than one item selected (where applicable), the first item will be opened. You can also open an item for editing by clicking on its Title or Name. See the section below called Template - Edit for information on the edit screen.
  • Help. Opens this Help Screen.

Site and Administrator Links[edit]

At the top left, above the columns, you will see two links as shown below:

Template manager links.png

  • Site. Shows the Templates available for the Front-end of the web site.
  • Administrator. Shows the Templates available for the Back-end of the web site. These Templates will control the appearance of the administrator portion of the site.

Template - Edit[edit]

How to Access[edit]

Navigate to the Template Manager. Then click on the Template's name or select a Template and click the Edit icon on the toolbar.

Description[edit]

This is where you can preview a Template, edit a Template's HTML and CSS files, and set parameters for a Template.

Screenshot[edit]

Template edit.png

Details[edit]

  • Name. The Template Name. No entry is allowed.
  • Description. A description of the Template. No entry is allowed.
  • Menus. If the Template is not the default Template, you can assign it to specific Menu Items. To select multiple Menu Items,hold down the Ctrl key while clicking with the mouse.

Parameters

Some Templates have parameters that allow you to change the way the web site will look. For example, the default rhuk_milkyway template allows you to choose a foreground color, a background color, and different Template widths. Other Templates may have different or no parameters.

Toolbar[edit]

At the top right you will see the toolbar:

Template edit toolbar.png

  • Preview. Opens a preview window of your web site using this Template. This window shows the available Module Positions ("top", "left", and so on) indicated in red type. This is shown in the screenshot below:

Template edit preview.png

Note: The preview of an administrator template does not show you the administrator module positions.
  • Edit HTML. Opens the "index.php" file from the Template for editing using a simple text editor. Press Save or Apply to save any changes you make. Press Cancel to cancel any changes. You can also edit this file outside of Joomla! with any HTML editor. Note that the full name of this file is displayed above the edit window.
  • Edit CSS. Opens a list of the CSS files used in this Template. To open one of the CSS files for editing, select the file and press the Edit icon in the toolbar. This will open this CSS file for editing using a simple text editor. Press Save or Apply to save any changes you make. Press Cancel to cancel any changes. You can also edit this file outside of Joomla! with any editor. Note that the full name of this file is displayed above the edit window.
  • Save. Save it and return to editing the menu details.
  • Apply. Save it, but stay in the same screen. If you have been working on a screen for a long time and don't want to risk losing your work, pressing Apply saves your work and lets you continue working. If, for example, you lost your Internet connection, your work will be saved up this point.
  • Close. Return to the previous screen without saving your work. If you press Close while adding a new item, this new item will not be created. If you were modifying an existing item, the modifications will not be saved.
  • Help. Opens this Help Screen.

Quick Tips[edit]

  • Important: Do not delete the default template files using FTP because it generates an error in both the front-end and back-end!
  • Before editing the HTML and the CSS file of the template, it is a good idea to make a backup of the file you are editing. Also, you can edit these files outside of Joomla! using the HTML or CSS editor of your choice.
  • The Preview will only display positions that contain published modules. To make sure you can see all positions defined in the template, you can create custom modules for them.
  • You cannot assign the default template to specific Menu Items. This is because it is already assigned to all Menu Items by default.

Related Information[edit]

Retrieved from "https://docs.joomla.org/index.php?title=Help15:Screen.templates.15&oldid=70292"