Note: You are currently viewing documentation for Moodle 2.9. Up-to-date documentation for the latest stable version of Moodle may be available here: Header and footer.

Header and footer: Difference between revisions

From MoodleDocs
m (minor tweak)
(removed ref to 29)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Site appearance}}
{{Site appearance}}
== Additional HTML ==
You can easily add links and other information to the top and bottom, and header and footer of your Mooodle site.


An administrator can add additional HTML or CSS or JavaScript to every page in ''Site administration > Appearance > Additional HTML''.
== Customising the header==
*The administrator can add links, metatags, CSS or Java Script to the header section of your page via ''Site administration > Appearance > Additional HTML''  
*You can  specify HTML or CSS or JavaScript that you want added to every page without altering the Moodle code files.  
* Add your HTML/CSS to the' Within HEAD' box


These settings allow you to specify HTML or CSS or JavaScript that you want added to every page without altering the Moodle code files.  
{|
| [[File:headerbox.png|thumb|400px|Adding HTML]]
| [[File:headerlink.png|thumb|400px|The resulting text]]
|}


You can add HTML, CSS or JavaScript, to three sections in the Additonal HTML page.
===Dropdown menus===
# Within HEAD: within the <head></head> tag for the page. (Example: Meta tags, CSS, JavaScript).
Although not strictly in the 'header' section, custom dropdown menus may be added to the top of your site via ''Site administration > Appearance > Themes > Theme settings''  and adding your links to the Custom menu box, using the examples given to help you.
# When BODY is opened: above the header section of the main body of the page that is displayed. (Example: Banner image or text heading, alert message).
# When BODY is closed: below the footer of the page. (Example: Google Analytics).  


Doing this allows you add custom headers or footers on every page, or add support for services like Google Analytics very easily and independent of your chosen theme.
[[File:custommenu.png|thumb|center|500px|Example of a site with custom dropdown menus]]


Another way of adding a custom footer or support for Google Analytics is via the settings of certain themes such as the Clean theme.
==Customising the footer==


==Moodle Docs==
*As with header options in the section above, the administrator can add links, CSS or Java Script to the footer section of your page via ''Site administration > Appearance > Additional HTML''  
[[File:MoodleDocsforthispageScreenshot.png|thumb|'Moodle Docs for this page' link]]
*This  might be useful for adding Google Analytics, for example.
Moodle Docs is an abbreviation for ''Moodle documentation''.
* Add your HTML/CSS to the 'Before BODY is closed' box.


By default, managers, teachers and non-editing teachers (and any other users with the capability [[Capabilities/moodle/site:doclinks|moodle/site:doclinks]]) have "Moodle Docs for this page" links at the bottom of each page in Moodle for accessing context-specific documentation.
===Footer link to Moodle docs===


An administrator can change Moodle Docs settings in ''Settings > Site administration > Appearance > Moodle Docs''.
*Moodle Docs is an abbreviation for ''Moodle documentation''.
*By default, managers, teachers and non-editing teachers (and any other users with the capability [[Capabilities/moodle/site:doclinks|moodle/site:doclinks]]) have "Moodle Docs for this page" links at the bottom of each page in Moodle for accessing context-specific documentation.


The default path is to docs.moodle.org. If a user has selected a language for which there is documentation available, the "Moodle Docs for this page" links will link to the documentation in that language.
[[File:MoodleDocsforthispageScreenshot.png|thumb|center|400px|'Moodle Docs for this page' link]]


If the Moodle Docs document root field is left blank, no "Moodle Docs for this page" links will appear.
*An administrator can change Moodle Docs settings in ''Administration > Site administration > Appearance > Moodle Docs''. The link can be made to open in a new window; the docs language may be forced, and the docs link may be removed by removing the link from the Moodle docs document root field.
*If you have your own custom documentation online or wish to link to other documentation online, you can change the link in this Moodle docs document root field.
*You can download the Moodle Docs files for several branches and languages of Moodle Docs from [http://wimski.org/docs/ http://wimski.org/docs/]. These files can be hosted in a local intranet and this may be useful for places that have strict internet policies that prevent Moodle users from reaching [https://docs.moodle.org/en/Main_page The Moodle Docs site].


You may find that teachers prefer the documentation to open in a new window, so they can easily return to their page in Moodle. If so, click the "Open in new window" checkbox.
==Theme settings options==
Some themes allow you to add custom CSS and footer text via their settings pages The standard 'Clean' and 'More' themes offer this option, via ''Site administration > Appearance > Themes > Clean/More''


As you may have discovered, Moodle Docs contains many searchable pages which represents 1,000s of hours of refinement by the Moodle community. For example, it is common to see a link from a forum in Moodle.org to a specific page or section in a Moodle Docs page. Likewise, something can be added to Moodle Docs to cover a new feature or to give a more detail description of a process that is not possible or desirable in a forum or as part of the help files.  
{|
| [[File:morefootnotebox.png|thumb|400px|Adding content to the footer in the More settings page]]
| [[File:morefootnote.png|thumb|400px|The resulting text]]
|}


Moodle Docs is a living document that is constantly changing at docs.moodle.org . Anyone in the Moodle community who sees a need is invited to make an addition or add their opinion in the page comments tab.
==Customising the 'main body' section==
*As with header and footer options, you can add code and script to the main body of the page.
*This might be useful for adding a banner image, a text heading or an alert message for example.
* Add your content to the 'When BODY is opened' box.


:Tip: If your site language is one for which there is unmaintained documentation (see [https://docs.moodle.org/overview/ Moodle Docs overview]) e.g. Czech and you wish to make use of the archived documentation, you can set the Moodle Docs document root to https://docs.moodle.org/archive/cs/.
The document root may also be changed to point to some custom online documentation. The paths the custom documentation should follow the same format as https://docs.moodle.org.


==See also==
==See also==

Latest revision as of 06:29, 1 July 2015

You can easily add links and other information to the top and bottom, and header and footer of your Mooodle site.

Customising the header

  • The administrator can add links, metatags, CSS or Java Script to the header section of your page via Site administration > Appearance > Additional HTML
  • You can specify HTML or CSS or JavaScript that you want added to every page without altering the Moodle code files.
  • Add your HTML/CSS to the' Within HEAD' box
Adding HTML
The resulting text

Dropdown menus

Although not strictly in the 'header' section, custom dropdown menus may be added to the top of your site via Site administration > Appearance > Themes > Theme settings and adding your links to the Custom menu box, using the examples given to help you.

Example of a site with custom dropdown menus

Customising the footer

  • As with header options in the section above, the administrator can add links, CSS or Java Script to the footer section of your page via Site administration > Appearance > Additional HTML
  • This might be useful for adding Google Analytics, for example.
  • Add your HTML/CSS to the 'Before BODY is closed' box.

Footer link to Moodle docs

  • Moodle Docs is an abbreviation for Moodle documentation.
  • By default, managers, teachers and non-editing teachers (and any other users with the capability moodle/site:doclinks) have "Moodle Docs for this page" links at the bottom of each page in Moodle for accessing context-specific documentation.
'Moodle Docs for this page' link
  • An administrator can change Moodle Docs settings in Administration > Site administration > Appearance > Moodle Docs. The link can be made to open in a new window; the docs language may be forced, and the docs link may be removed by removing the link from the Moodle docs document root field.
  • If you have your own custom documentation online or wish to link to other documentation online, you can change the link in this Moodle docs document root field.
  • You can download the Moodle Docs files for several branches and languages of Moodle Docs from http://wimski.org/docs/. These files can be hosted in a local intranet and this may be useful for places that have strict internet policies that prevent Moodle users from reaching The Moodle Docs site.

Theme settings options

Some themes allow you to add custom CSS and footer text via their settings pages The standard 'Clean' and 'More' themes offer this option, via Site administration > Appearance > Themes > Clean/More

Adding content to the footer in the More settings page
The resulting text

Customising the 'main body' section

  • As with header and footer options, you can add code and script to the main body of the page.
  • This might be useful for adding a banner image, a text heading or an alert message for example.
  • Add your content to the 'When BODY is opened' box.


See also