Adaptable theme

Revision as of 13:28, 31 May 2016 by Mary Cooch (talk | contribs) (copied from 3.0 docs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This is a contributed (third party) highly customisable two column theme designed to work in a range of different situations. It is based on the popular BCU theme. Adaptable has all the features of BCU along with many new features.

Features

Layout Builders! You can now define a custom layout in the admin settings for:

  • Block Regions (drag and drop)
  • Marketing Blocks
  • Footer Blocks
  • Fully Customisable:
    • Fonts
    • Colors
    • Block styles (including icons)
    • Buttons (including radius)
  • Choice of two JQuery sliders on home page with customisable colors
  • News / Announcements Ticker on home / Dashboard
  • Multiple Front page course styles
  • Extensive custom menus (can be targeted to different users based on custom profile field)
  • "My Courses" list can be organised to put older courses in sub menu item
  • Dismissible Bootstrap Alerts
    • Display sitewide notices using different Bootstrap styles
    • Allow users to dismiss alerts once read (persistent between page loads / login)
    • Allow re-use of alerts (display again even if user has dismissed) buy updating a "key" field
  • Additional layout settings for width, slider width, padding of various elements
  • Social icons or Search box in header (admin can choose between the two)
  • Support for Social Wall Course Format (thanks to Chris Kenniburg for help on this)
  • Mobile settings (greater control of how the theme looks on mobile devices)
  • Option to add login form in header on front page
  • Favicon uploader
  • Background image uploader

In addition, many fields (menus, news items, alerts and help links) can be targeted using custom profile fields, thus it is possible to present different users with different navigation items and notices.

It is also possible for individual users to customise where they want top menu navigation to appear (disable, home pages only, sitewide) using custom profile fields.

Demo Video

YouTube video

Demo site

http://3-bits.com/demo/adaptable/

Screenshots

adaptable-select.png adaptable-front-page.png adaptable-alerts.PNG reduced adaptable-colors.png adaptable-fonts.png block-region-builder.png block-region-front-page.png adaptable-mobile-social-on.PNG

Download

From the Moodle plugins database.

Installation

  • Make sure you have all the required versions.
  • Download and unpack the module.
  • Place the folder ("adaptable") in the "theme" subdirectory.
  • Visit http://yoursite.com/admin to finish the installation

Configuration

Adaptable has a lot of settings and may seem daunting at first, our advice is to simply install with the default settings and play with it afterwards.

With a little time you should be able to setup an attractive Moodle site with a high degree of individuality without knowing any CSS.

You can work on configuring the theme without it being live on your site by putting theme=adaptable or theme=clean into the URL. See Allow theme change by URL.

Theme settings that will be linked to by 'Moodle Docs for this page'

Colours

You can select the colours that you would like to use throughout the theme. Use Hexadecimal color notation or any other standard notation. As an alternate option you can use transparent and inherited as a value

Fonts

You can select the Google Fonts that you would like to use throughout the theme. Select the subset needed (latin is always included) and enter the right font weight or the font will not displayed.

Buttons

Alter the appearance of buttons used in this theme. Configure as needed.

Header

  • Customize the header of this theme.
  • Upload your favicon, logo, set login form in header, adjust titles in header.
  • You can set font size and styles for titles in the "fonts" settings page.

Header Menus

  • Tools Menus (in navbar) and Top Menus (upper header) can be restricted based on custom profile fields (optional).
  • To add a restriction enter the name of the profile field and expected value.
  • Menu Structure follows the common Moodle format:
Moodle community|https://moodle.org
-Moodle free support|https://moodle.org/support
-Moodle development|https://moodle.org/development
--Moodle Docs|http://docs.moodle.org
--German Moodle Docs|http://docs.moodle.org/de
Moodle.com|http://moodle.com/
  • General settings for Top Menu visibility
    • These settings allow you to control where menus appear and optionally allow users to customise their settings

Header User

Allows you to control all of the elements that appear in the user navigation dropdown.

Header Social

  • You can disable the sitewide search box and enable social icons / links in its place.
  • To setup icons enter a de-limited list into the "Social Icon List" field below.
  • This should be in the format:
url|title|icon
    • For example:
http://localhost/moodle/course/search.php%7CSearch Moodle|fa-search
http://facebook.com/%7CFacebook%7Cfa-facebook-square
http://twitter.com/%7CTwitter%7Cfa-twitter-square
http://instagram.com%7CInstagram%7Cfa-instagram

Header Navbar

... customize as needed ...

Header Tools Menu

... customize as needed ...

Block Settings

... customize as needed ...

Block Region Builder

  • You can build your own layout for block regions on the Front page.
  • To add content these regions you will need to Turn editing on on the Front page of Moodle.
  • Then you can begin to drag/drop blocks into the regions you create!

Course Sections

... customize as needed ...

Marketing Blocks

  • There are two full width info boxes witht differing styles you can use.
  • In addition to this there is a layout builder, allowing you to decide how many blocks you need and define your own layout.
  • Please see the README file that comes with this theme.

Front page Courses

Configure the way that the course boxes are rendered on the Front page.

Frontpage Ticker

  • Here you can set a news ticker to run across the Front page of your Moodle site.
  • It is intended as a less intrusive alternative to the slider, taking up very little space.
  • To setup your ticker, simply entere a bulleted list and include any hyperlinks you need to in that text.
  • Note: you must not put ul tags around our list, only li. Moodles Text editor tends to add ul tags.
  • If your ticker does not load properly, switch to HTML view and ensure you have only li tags:
<li>News item one.....</li>
  <li>News item two.....</li>

Frontpage Slider

  • Upload the images, add the links and description for the carousel on the Front page.
  • Sample HTML for Slider Captions:
<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Please favorite our theme!</a>

Alert Box

  • Enter and customize a text to be displayed in the top of the site as an alert.
  • It is possible to set more than one alert to target different user types.
  • You also have the option of showing alerts sitewide or on homepages only.

Layout

Set the default layout that users see.

Footer

Set the content that should appear in the footer

Mobile Settings

Control how your site looks on mobile devices

Social Wall

Customise the appearance of the Social Wall Course Format (if in use on your site)

Custom CSS & JS

Here you can find various settings to add your own CSS and JavaScript code to the theme.

Analytics

You can setup multiple codes for Google Analytics and targed them to user profile fields.

Migration from BCU to Adaptable

Advice on migrating from BCU to Adaptable can be found here

HTML code for settings and block areas

Here you will find some code samples to help you to customize the Info Box and the Marketing Blocks

You can insert any HTML tag to customize the Front page blocks. Use a <div> as a main container and add the height to keep the same value in all the blocks.

The Font Awesome icons set is available in http://fortawesome.github.io/Font-Awesome/icons/. You can insert any of them and following the examples in http://fortawesome.github.io/Font-Awesome/examples/


Front Page Slider Styles

There are two possible slider styles each with different markup required:

Original BCU Slider Markup

<div class="span9">
 
  <h4>Information</h4>
 
    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
    et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
    ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
  </div>
 
  <div class="span3">
 
  <a href="#" class="submit">2013/14 Courses <i class="fa-chevron-right fa"></i></a>
 
 </div>

Coventry Style Slider Markup

<div class="span6 col-sm-6">
<h3>Hand-crafted</h3> <h4>pixels and code for the Moodle community</h4>
<a href="#" class="submit">Check out our custom theme pricing!</a>
</div>

Frontpage Marketing Block HTML structure Coventry

<div><img src="http://somewebsite.com/2.jpg" class="marketimage"></div>
<h4><a href="#">International Courses</a></h4>
<p>Some text below the link....</p>

Front page Info Block

There are two Info blocks in the frontpage located above and below the Marketing Blocks. See pix/layout.png


Simple box with solid background and using a default heading

<div style="text-align:center; background: #f0f0f0;">
    <h3 style="text-align: center;">Add your text here</h3>
</div>

Simple box with solid background colour, default heading h3 and white text colour

<div style="text-align:center; background: #009688; color: #ffffff;">
    <h3 style="text-align: center;">Add your text here</h3>
</div>

Front Page Secondary Info Block Example

You can apply additional styles to the secondary info block:

<div class="span2 personpic">
    <div id="person" class="spn5">
        <img src="/urltoanimage.jpg" alt="person">
    </div>
</div>
 
<div class="span10">
    <h4>School of Jewelry</h4>
    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
    Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
    Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
    <a href="#" class="submit">Learn more... <i class="fa-chevron-right fa"></i></a>
</div>

Frontpage Marketing Block HTML

You can add up to 12 Marketing Blocks in the Front page. The blocks are located automatically in rows, with a maximum of 4 blocks per row. The full width is divided equally between the blocks.

Simple Block with white background and Font Awesome icon. Using the default text colour and h3 heading

<div style="text-align:center; background: #ffffff; height: 240px; padding: 7px;">
    <i class="fa fa-font fa-5x"></i>
    <h3 style="color: #333333;">TITLE</h3>
    <div style="text-align:center;">Add your text here</div>
</div>

Block with solid background colour, white text colour and Font Awesome icon

<div style="text-align:center; background: #4b4b4b; color: #ffffff; height: 240px; padding: 7px;">
    <i class="fa fa-th fa-5x"></i>
    <h3 style="color: #ffffff;">TITLE</h3>
    <div style="text-align:center; padding: 5px;">Add your text here</div>
</div>

Block with solid background, white text colour and text aligned vertically (useful for blocks 100% wide)

<div style="background: #c2185b; height: 120px;">
    <h1 style="line-height: 120px; color: #ffffff; text-align: center; "><b>moodle 3.0 ready !!!</b></h1>
</div>

Footer Blocks

Contact information

<i class="fa fa-building"></i>  High St. 100<br>
<span style="margin-left: 20px;">123456 City</span><br><br>
<i class="fa fa-phone"></i> +12 (3)456 78 90<br>
<i class="fa fa-envelope"></i> info@mail.com<br>
<i class="fa fa-globe"></i> www.example.com

List with Chevron

<ul class="block-list white">
    <li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Accessibility</span></a></li>
    <li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Help</span></a></li>
    <li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>Moodle Feedback</span></a></li>
    <li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Help</span></a></li>
    <li><a href="http://moodle.org/"><span class="icon-right-open-mini"></span><span>IT Feedback</span></a></li>
</ul>
</nowiki>

Credits

Support

Please post your questions in our support thread to which we are subscribed.

We do not provide direct support

See also

The authors documentation page at https://bitbucket.org/covuni/moodle-theme_adaptable