Difference between revisions of "Help:Contents"

From BCcampus Mediawiki
Jump to: navigation, search
(Created page with "In addition to the the regular mediawiki functionality which is fully documented in the end user manual, we have customized this mediawiki to make it more powerful. =Embed Yo...")
 
(Sample result)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
In addition to the the regular mediawiki functionality which is fully documented in the end user manual, we have customized this mediawiki to make it more powerful.
+
In addition to the the regular mediawiki functionality which is [http://www.mediawiki.org/wiki/Help:Contents fully documented in the end user manual], we have customized this mediawiki to make it more powerful.
  
 
=Embed Youtube Videos=
 
=Embed Youtube Videos=
Line 12: Line 12:
 
== Sample result ==
 
== Sample result ==
 
{{#widget:YouTube|id=Ukytqe9pwDM}}
 
{{#widget:YouTube|id=Ukytqe9pwDM}}
 +
 +
=Embed Google Calendars=
 +
To insert this widget, use the following code:
 +
 +
<nowiki>{{#widget:</nowiki>{{PAGENAME}}<nowiki>
 +
|id=si8ocqn3duj6f8int3h57jm8qeunplut@import.calendar.google.com
 +
|color=528800
 +
|id=p2m2av9dhrh4n1ub7jlsc68s7o@group.calendar.google.com
 +
|color=2952A3
 +
|id=usa@holiday.calendar.google.com
 +
|color=B1440E
 +
|title=TechPresentations, NYCResistor, US Holidays
 +
}}</nowiki>
 +
 +
== Parameters ==
 +
* '''id''' - is a calendar ID (including <code>@calendar.google.com</code>, come match user email addresses) - can be found on calendar settings page
 +
* '''title''' - new title if you want to override calendar title (optional)
 +
* '''height''' and '''width''' define calendar dimensions, 100%x600 is default (only width can be defined in %).
 +
* '''color''' - events color (hex value. e.g. 5229A3) - only color used in [http://www.google.com/calendar/embedhelper Google's wizard] can be used.
 +
* '''bgcolor''' - background/border color (hex value. e.g. ffcc66)
 +
* '''weekstart''' - first day of the week (1-7)
 +
* '''lang''' - interface language (en, fr, ru and etc).
 +
* '''view''' - default view MONTH (default)/WEEK/AGENDA)
 +
* '''timezone''' - time zone defined as a string like "America/New_York", should be automatically detected if omitted
 +
* '''pvttk''' - This key is used to access non-public calendars.  All calendars must be on a single account.
 +
* '''style''' - The style attribute to be applied to the iframe.
 +
* You can also trigger parts of the interface on and off:
 +
** '''showtitle''' - true (default)/false - shows title
 +
** '''shownav''' - true (default)/false - shows navigation arrows
 +
** '''showdate''' - true (default)/false - shows date
 +
** '''showtabs''' - true (default)/false - shows view tabs
 +
** '''showcals''' - true (default)/false - shows a calendar list
 +
** '''showprint''' - true (default)/false - shows a print icon
 +
** '''showtz''' - true (default)/false - shows timezone
 +
** '''border''' - true/false (default) - draws thin border around the widget
 +
* '''app''' - for [http://www.google.com/apps/ Google Apps for Your Domain] Calendars, specify the domain name for the account (<code><nowiki>http://www.google.com/calendar/hosted/</nowiki>'''yourdomain.com'''/render</code>)
 +
 +
== Sample result ==
 +
Displaying 3 different calendars:
 +
* [http://www.techpresentations.org/Conferences#Current_.26_Upcoming_conferences TechPresentations.org: Current and Upcoming Conferences]
 +
* [http://www.nycresistor.com/ NYCResistor events]
 +
* US Holidays
 +
{{#widget:Google Calendar
 +
|id=si8ocqn3duj6f8int3h57jm8qeunplut@import.calendar.google.com
 +
|color=528800
 +
|id=p2m2av9dhrh4n1ub7jlsc68s7o@group.calendar.google.com
 +
|color=2952A3
 +
|id=usa@holiday.calendar.google.com
 +
|color=B1440E
 +
|title=TechPresentations, NYCResistor, US Holidays
 +
}}
 +
=Insert a Google Spreadsheet=
 +
To insert this widget, use the following code:
 +
 +
<nowiki>{{#widget:</nowiki>{{PAGENAME}}<nowiki>
 +
|key=po-s58YMwf85Q3UxRzdGOBw
 +
|width=500
 +
|height=300
 +
}}</nowiki>
 +
 +
== Parameters ==
 +
* '''key''' - key parameter in document URL
 +
* '''width''' and '''height''' define spreadsheet dimensions, 500x300 is default, but you might want to copy it from embed code since size depends on fields you have
 +
* '''page''' - set it to embed whole page with edit links and more.
 +
 +
== Security NOTE ==
 +
Keep in mind that to use this widget you must make the document you're publishing to be open for everybody to see which might be undesirable for some uses (intranets, closed groups and etc.)
 +
 +
== Related widgets ==
 +
* [[Widget:Google Document|Google Document]] - for embedding documents
 +
* [[Widget:Google Form|Google Form]] - for embedding spreadsheet forms
 +
* [[Widget:Google Presentation|Google Presentation]] - for embedding presentations
 +
 +
== Sample result ==
 +
{{#widget:{{PAGENAME}}
 +
|key=po-s58YMwf85VdL_dX0w3VQ
 +
|width=100%
 +
|height=150
 +
|page=true
 +
}}
 +
=Embed a Slideshare Presentation=
 +
To insert this widget, use the following code:
 +
 +
<nowiki>{{#widget:</nowiki>{{PAGENAME}}<nowiki>
 +
|doc=semantic-media-wiki-semantic-forms-1205504882436734-4
 +
|width=425
 +
|height=348
 +
}}</nowiki>
 +
 +
== Parameters ==
 +
* '''doc''' - is a parameter from embed code (click "embed -> customize" and copy "doc" parameter from WordPress short code)
 +
* '''start''' - optional parameter to define start slide number
 +
* '''width''' & '''height''' - optional, 425x348 is a default
 +
* '''player''' - defaults to '2' and allows you to switch to other players
 +
* '''norelated''' - if set, widget will not display related content and sharing functionality at the end of the deck
 +
 +
== Sample result ==
 +
{{#widget:SlideShare
 +
|doc=authoring-open-textbooks-120206163312-phpapp02
 +
}}

Latest revision as of 00:18, 9 February 2012

In addition to the the regular mediawiki functionality which is fully documented in the end user manual, we have customized this mediawiki to make it more powerful.

Embed Youtube Videos

To insert a Youtube video, use the following code:

 {{#widget:YouTube|id=DWef69ItVrU}}

Parameters

  • id - video id (from the URL)
  • height and width define view dimensions, 420x350 is default

Sample result

Embed Google Calendars

To insert this widget, use the following code:

{{#widget:Contents
|id=si8ocqn3duj6f8int3h57jm8qeunplut@import.calendar.google.com
|color=528800
|id=p2m2av9dhrh4n1ub7jlsc68s7o@group.calendar.google.com
|color=2952A3
|id=usa@holiday.calendar.google.com
|color=B1440E
|title=TechPresentations, NYCResistor, US Holidays
}}

Parameters

  • id - is a calendar ID (including @calendar.google.com, come match user email addresses) - can be found on calendar settings page
  • title - new title if you want to override calendar title (optional)
  • height and width define calendar dimensions, 100%x600 is default (only width can be defined in %).
  • color - events color (hex value. e.g. 5229A3) - only color used in Google's wizard can be used.
  • bgcolor - background/border color (hex value. e.g. ffcc66)
  • weekstart - first day of the week (1-7)
  • lang - interface language (en, fr, ru and etc).
  • view - default view MONTH (default)/WEEK/AGENDA)
  • timezone - time zone defined as a string like "America/New_York", should be automatically detected if omitted
  • pvttk - This key is used to access non-public calendars. All calendars must be on a single account.
  • style - The style attribute to be applied to the iframe.
  • You can also trigger parts of the interface on and off:
    • showtitle - true (default)/false - shows title
    • shownav - true (default)/false - shows navigation arrows
    • showdate - true (default)/false - shows date
    • showtabs - true (default)/false - shows view tabs
    • showcals - true (default)/false - shows a calendar list
    • showprint - true (default)/false - shows a print icon
    • showtz - true (default)/false - shows timezone
    • border - true/false (default) - draws thin border around the widget
  • app - for Google Apps for Your Domain Calendars, specify the domain name for the account (http://www.google.com/calendar/hosted/yourdomain.com/render)

Sample result

Displaying 3 different calendars:

Insert a Google Spreadsheet

To insert this widget, use the following code:

{{#widget:Contents
|key=po-s58YMwf85Q3UxRzdGOBw
|width=500
|height=300
}}

Parameters

  • key - key parameter in document URL
  • width and height define spreadsheet dimensions, 500x300 is default, but you might want to copy it from embed code since size depends on fields you have
  • page - set it to embed whole page with edit links and more.

Security NOTE

Keep in mind that to use this widget you must make the document you're publishing to be open for everybody to see which might be undesirable for some uses (intranets, closed groups and etc.)

Related widgets

Sample result

Error in widget Contents

Embed a Slideshare Presentation

To insert this widget, use the following code:

{{#widget:Contents
|doc=semantic-media-wiki-semantic-forms-1205504882436734-4
|width=425
|height=348
}}

Parameters

  • doc - is a parameter from embed code (click "embed -> customize" and copy "doc" parameter from WordPress short code)
  • start - optional parameter to define start slide number
  • width & height - optional, 425x348 is a default
  • player - defaults to '2' and allows you to switch to other players
  • norelated - if set, widget will not display related content and sharing functionality at the end of the deck

Sample result