Wikieducator tutorial/RTE Tutorials

From WikiEducator
Jump to: navigation, search

Note that this page, discussing plans and progress toward development of RTE tutorials, is a sub-page of original "wikitext" tutorials, not the main page for WikiEduator rich text editor tutorials.

General items for all RTE tutorials

  • Insert <ref> tag for all links for use when printing an off line version of the tutorials
  • Update print specific templates, using the No print category for navigation templates and Template:Foo/print for new collection extension (may need to wait until live on the AU servers.)
  • Test for print version of all tutorials.
  • With reference to all FAQ pages -- remove invite to list FAQs on the tutorial page and post a link to the main WE list and/or relevant discussion page for support questions.

(Comment.gif: Do you have an estimate for the number of hours the general items will take? The print version of the templates could eat up a fair amount of time depending on how different the pdf extension is. I tried to do some tests but the AU wiki is located for a database update.)

I think it may be better to specify this as a separate statement of work / consultancy and collapse this with any other updates which may be required with the migration to the latest version of the collection extension. I don't want to guess a time estimate yet, but included this here on the to list for the future so that I don't forget --Wayne Mackintosh 04:46, 18 October 2009 (UTC)

(Comment.gif: Another possibility for the FAQs page could be to have the summary/content in a template (which would be locked) and the FAQs page open for editing. This keeps the FAQs in the wiki and would allow users to edit freely (maybe even reduce the amount of reversions)? )

I think we need to protect all the tutorial pages as these are high traffic pages and will reduce the amount of reversions needed. So I imagine the FAQ page been locked with a solution eg posting to the main list or discussion page for support related questions. There are significant improvements with the latest version of LQT. --Wayne Mackintosh 04:46, 18 October 2009 (UTC)
Where can a fella find out, what the improvements to LQT are? Randy Fisher 21:07, 14 February 2010 (UTC)

I am adding a      trough items once they have been actioned. Rob Kruhlak 07:03, 5 November 2009 (UTC)

Style Guide

(Comment.gif: Suggest that we have a few standards on language use, formatting,... Here's my thoughts on a few. --Alison Snieckus 14:47, 20 February 2010 (UTC))


  • Use of the following terms should be in lowercase when used as general improper nouns (unless referring to a specific field, button, or other screen feature, in which case format as written on the screen).
    • wiki
    • username (also, all one word)
    • password (also, all one word)
    • rich text editor
    • web site (as two words)
  • While "rich text editor" is an improper noun describing a kind of editor, "Rich Editor" is the name of WikiEducator's rich text editor, suggesting it should be capitalised.
  • Use the term "Rich Editor toolbar", with "Rich Editor" capitalised, when referring to the toolbar on the FCK editor.
  • (Comment.gif: current standard for user page appears to be "User page", but "userpage" and "user page" are also used. Any reason to choose one over another? --Alison Snieckus 17:45, 20 February 2010 (UTC))
  • Use "log in" when used as a verb (e.g., to log in to WikiEducator) and log-in when used as an adjective or noun (e.g., log-in account).
  • (Comment.gif: it seems like we should be as consistent as possible with what term we use for wiki code. I think the concept is first introduced (formally) in the introduction section of Editing Basics tutorial: "Editing with standard wiki markup (sometimes called "wiki text" or "wiki syntax")". At first I agreed that "standard wiki markup" is a good way to describe it, but then I got to the part about "temporary wikitext". Now I wonder if we should be using the term "wikitext" as our standard, noting that it's sometimes called markup or syntax). Thoughts? --Alison Snieckus 23:45, 18 February 2010 (UTC))

Within-text formatting

(Comment.gif: I've noticed a few different formats used when referring to names, text entries, and actions to be performed. I'm suggesting the following. I started implementing it here, before which I was quoting all three of these situations. I'm happy to revise all of the pages to reflect these, or another set of guidelines, as desired. --Alison Snieckus 03:43, 1 March 2010 (UTC)):

  • Italicise the names of screen features, e.g., menus, tools, fields, and dialog boxes), making sure to type the name exactly as displayed in the application, e.g., The Link dialog box.
  • Put quotes around text phrases, whether as viewed on the screen or to be entered via the keyboard, e.g., "Learning4Content" is the page name....
  • Bold names which are used in actions or commands, e.g., "Click on the Insert/Edit Link button...."

(Comment.gif: Wondering if we should add the flickr attribution template to each of the flickr images in the tutorial. I've done so here and here, but I'm not happy with the results. I think the attribution distracts the user from the caption. And, what about the non-flickr images? What is the best practice here: show attribution on each page that uses the image or leave the attribution to be on the image page only? --Alison Snieckus 18:35, 27 February 2010 (UTC))

Hi Alison -- the FA template is redundant if the image page uses the Metadata template. Image attribution is messy in WE --- something we need to tidy up. Personally I have a preference for using the Metadata template on the image page -- in this way we remain consistent with where the Wikimedia Commons publish licensing information. --Wayne Mackintosh 02:05, 28 February 2010 (UTC)
I agree. It's redundant (and in my opinion detracts from the caption). I'll remove the template from the two images that I added it to, and put on my list of things to check, that all of the images include the metadata template. Thanks for your thoughts on this. --Alison Snieckus 02:29, 28 February 2010 (UTC)

  • Include a caption describing an image, or its relevance to the content. Images should include attribution (using Template:Metadata) on the image page; attribution statements are not displayed on the image when included on a page.

Layout and formatting of activities

(Comment.gif: I've noticed that most, but not all of the instructional activities (the ones that have learners create something in the RTE/wiki software) were formatted as a numbered list of steps. I've written a number of instructional-type activities, in particular this past year, and I've developed a different style: actions to be taken by the learner are listed as bullets (with the screen feature that needs to be acted on shown in bold), descriptions of what happens on the screen written in plain text in present tense. The result is that the list of what to do is broken up into chunks. My thinking is that the chunked visual layout of the activity helps learners keep track of where they are in the activity without having to specifically attend to the numbered step, but I don't have feedback on whether that's the case or not. I've revised some of the RTE tut activities to this style so we can compare the two styles:
(Example 1) internal link activity, see history from Feb 26 for comparison to numbered style;
(Example 2) external link activity, see history from Feb 26 to see numbered style
I guess the question is what style seems best for new wiki users who have chosen the RTE tuts. Thoughts? (I'm happy to revise the activities to fit whatever style we think is best.) --Alison Snieckus 14:58, 1 March 2010 (UTC)

Project set-up and multimedia development

  • Setting up pages and creating navigation templates for each tutorial. 8 hours
  • Reworking / creating 12 screen cast videos. 8 hours

Total time for project: 6 FTE days

Tutorial 1: What is a wiki

Estimated time for revision: 2 hours

  • Create new navigation template for the RTE tutorial version
  • Create new pages for RTE version of tutorial 1
  • Home page
    • Review and update any links
  • Advantages and disadvantages
    • <strike>Review and update any links
  • About WikiEducator
    • Review and update links for better examples now available in the wiki
  • Summary and FAQs
    • Review and add any FAQs based on our experience from Learning4Content (Comment.gif: Have added links to google group and talk page as teh FAQs page will most likely be protected due to the high traffic. Do we want the FAQs link to go to the main FAQ page of WE or the L4C FAQ page? Thoughts? Rob Kruhlak 05:39, 12 December 2009 (UTC))
  • Final language edit. (Comment.gif: Hi Helena, With regards to your addition to the advantages and disadvantages, I think there is still a need to preview, especially, pages with templates. Not sure what to suggest in its place, need to think about this. Rob Kruhlak 05:16, 12 December 2009 (UTC))
Re: I agree that previewing is still helpful, so I revised the wording of this bullet replacing the "preview" text with a more general "facilitating formatting and layout..." --Alison Snieckus 23:25, 9 February 2010 (UTC)

(Comment.gif: Have added link to main FAQs page but maybe more FAQs as we work through however unable to make any changes to the FAQ page - Helena)

Re: Hi Helena, This is strange as the FAQ page is not protected unless I'm looking at the wroing page. Can you link to the page for us? Rob Kruhlak 03:01, 2 December 2009 (UTC)

Re: Hi Rob, It was a no edit tag that was in the code that took me a wee while to discover. Helena Mill

Tutorial 2: Creating an account

Estimated time for revision: 3 hours

  • Create new navigation template for the RTE tutorial version
  • Create new pages for RTE version of tutorial 2
  • Home page
    • Wayne to create updated slideshow for WE
    • Wayne to update audio recording --- remove references to COL & update for OERF
(Comment.gif: list of browser software lists both Firefox and Mozilla, redundant?: "(Firefox, Mozilla, Internet Explorer, Safari, Netscape, etc.)". Also, maybe should add Chrome. (See also list in first activity on detailed instructions page.) --Alison Snieckus 23:35, 9 February 2010 (UTC))
  • Benefits
    • No updates anticipated -- copy over to new page
  • Detailed Instructions
    • Update screen shot for new captcha extension
    • Update links to new screencast videos
    • Review for any further updates
    • Added a direct link to the Create account page in activity 1. Rob Kruhlak 05:57, 12 December 2009 (UTC)

::(Comment.gif: the create account link didn't work for me -- brought me to an error page: "No such special page. You have requested an invalid special page. A list of valid special pages can be found at Special pages." I revised it, deleting the &type-signup bit. Note that I was logged out when I tested it. --Alison Snieckus 03:42, 10 February 2010 (UTC))

(Comment.gif: Thanks Alison, Interesting. Not sure if it was a typo or the version change. It should be working now. Rob Kruhlak 04:42, 10 February 2010 (UTC))
Re: yup, working as you intended. --Alison Snieckus 20:36, 10 February 2010 (UTC)

:(Comment.gif: the recaptcha link is red and doesn't seem to even have a page that could be used. Maybe refer users to the recaptcha learnmore page? --Alison Snieckus 03:42, 10 February 2010 (UTC))

Re: link set to main recaptcha site. --Alison Snieckus 22:38, 18 February 2010 (UTC)
  • Show_me_how
    • Create new screen cast (for use with new captcha utility)
    • Split the login / create new account part from the screen filling in personal details so that we have two screencasts to match the activity links on the Detailed instructions page.
  • Summary and FAQs
    • Wayne to update this FAQ re OERF
    • Add a few FAQs relating to setting user preferences
    • Check with Jim re our planned implementation of RTE defaults for enabling the RTE editor.
    • (Comment.gif: Wondering if I should revamp the self-assessment so it's interactive (the responses are available by clicking the show link). Seems like it would improve the experience for users. Thoughts? --Alison Snieckus 21:57, 10 February 2010 (UTC))
  • Final language edit. (Comment.gif: Up to Detailed instructions. Is there a way to disable the test server notice for the screencasts? Rob Kruhlak 06:01, 12 December 2009 (UTC))

Tutorial 3: Editing basics

Estimated time: 3 hours

  • Create new navigation template for the RTE tutorial version
  • Create new pages for RTE version of tutorial 3
  • Home page
    • Ask Brent to update audio file (i.e. remove reference to COL)
    • Update page for RTE (i.e. remove reference to raw wiki text)
  • Edit mode
    • Add paragraph or subsection with reference to RTE
    • Review content for any updates required
    • Update page for RTE (i.e. remove reference to raw wiki text)
    • Add screen shot of edit view using RTE -- Added screenshots of wikitext, rich text toolbars.
    • Remove cheatsheet activity -- no longer necessary.
    • May need a screenshot of the RTE edit mode. Rob Kruhlak 06:35, 5 December 2009 (UTC)
    • Probably need to describe how to get to Rich editor mode as I think wikitext is the default. Rob Kruhlak 06:35, 5 December 2009 (UTC)
    • I think we need to add a section on the wikitext mode as well as the rich editor mode so that we can refer back to it from the later tutorials. I already have some links to a section heading called ==Wikitext_mode==. The advantage (or disadvantage if you make a mistake) to using the wikitext mode as compared to disabling the rich editor is that once you preview you are back in the rich editor. Rob Kruhlak 06:35, 5 December 2009 (UTC)
  • First edit
    • Review for any changes for RTE
      • Wikieducator_rich_text_editor_tutorials/Editing_basics/Edit_mode#Wikitext_mode (Heading is Wikitext editing). Need to update tutorials (6-10) Rob Kruhlak 08:46, 2 February 2010 (UTC)
    • Do we need a screen shot?
  • Show me how
    • Create new screencast using RTE
  • Summary and FAQs
    • Review summary
    • Add a few relevant FAQs based on our experiences of Learning4Content
      • Could be very different problems (ie getting to rich text mode). Have removed FAQs to start from a clean slate. Rob Kruhlak 08:46, 2 February 2010 (UTC)
  • Final language edit.

Tutorial 4: Basic Text Formatting

Estimated time: 4 hours

  • Create new navigation template for the RTE tutorial version
  • Create new pages for RTE version of tutorial 4
  • Home page
    • Update subsection for RTE
  • Creating a sandbox
    • Will need steps for inserting a new subpage plus screen shots of the new page pop-up window used by the FCK editor
    • Consider an input box solution or some automation for setting up a sandbox -- Chat with Jim about a default set up for new user pages (eg including a default welcome message template, inserting the sandbox and personal userbox.
      • Added an input box for creating a sandbox subpage linked from user page. Rob Kruhlak 07:52, 4 February 2010 (UTC)
(Comment.gif: Input box looks good...I already have a sandbox, so I assume I can't try it out. One thing, I noticed that the My Sandbox text on the button is not displaying as bold. --Alison Snieckus 02:41, 22 February 2010 (UTC))
(Comment.gif: It seems to me that this particular tutorial would be most used by new members who are relatively unfamiliar with rich text editing. New users who are unfamiliar with working in a wiki, but prficient in word processing, would probably skim through this material. With that in mind I wonder if the presentation of the nested list is too big a leap for these users. It might be better to do a summary of the functions presented and then present in a very basic way the additional available basic formatting/editing functions: cut, copy, paste, undo, redo, find, replace, select all, remove formatting, strikethough, subscript, superscript, and block quote. And then, since it's a FAQ page, have a section that covers formatting that the rich text editor can't do and point users to the relevant page in the wikitext tutorials or a relevant help page. Just a thought. --Alison Snieckus 03:12, 26 February 2010 (UTC))
  • Final language edit.

(Comment.gif: With regards to automating the sandbox creation, I have set up this template to be used via substitution for Gladys (eL4C31) to make it easier to populate her participants user pages. It includes a link to a sandbox, a personal infobox as well as a welcome message. It should be good for other L4C workshops and the section on creating a sandbox could be replaced with a link to the sandbox?)

That's a good idea -- we can tweak this a little with an input box embedded in the tutorial where the default is "User:" -- something like Create an institutional OER portal page --Wayne Mackintosh 23:38, 21 October 2009 (UTC)

Tutorial 5: New pages and links

Estimated time: 4 hours

  • Create new navigation template for the RTE tutorial version
  • Create new pages for RTE version of tutorial 5
  • Recommend new order for this tutorial -- cover external links before doing internal links

(Comment.gif: I think this is a good idea. Rob Kruhlak 07:29, 8 November 2009 (UTC))

  • Consider whether it is better to teach links to existing internal links before covering new pages

(Comment.gif: This is probably a good idea also.Rob Kruhlak 07:29, 8 November 2009 (UTC))

  • Home page
  • Need an introduction section introducing two types of links
  • New pages and links
    • See comment about sequencing above moved after internal links and before interwiki links Rob Kruhlak 07:52, 5 February 2010 (UTC)
    • Review and update page for RTE
    • Consider removing the reference to creating new pages from the url -- not ideal for newbies. Suggest moving this feature to the FAQ section.
    • Incorporate screenshot with labels for the new RTE interface
  • Internal links
    • moved before new pages Rob Kruhlak 07:52, 5 February 2010 (UTC)
  • Interwiki links (Comment.gif: Added this page to the original tutorial based on feedback on tutorial FAQ page. Will need to be tweaked for RTE version but the sequence should be okay. Rob Kruhlak 07:29, 8 November 2009 (UTC))
    • See comment about sequencing above
    • Review and update page for RTE
    • Incorporate screenshot with labels for the new RTE interface
  • External links
    • See comment about sequencing above moved to after intro Rob Kruhlak 07:52, 5 February 2010 (UTC)
    • Review and update page for RTE
    • Consider using a better subheading structure for the different types of external links, eg Footnote, direct link, pipes
    • Incorporate screenshot(s) with labels for the new RTE interface
  • Screencast
    • Create new screencast using RTE Created one for internal links. Do we want one for external links or new pages? Rob Kruhlak 08:04, 13 February 2010 (UTC)
  • Summary & FAQs

(Comment.gif: I think the answer to last question only applies to PC based browsers.... Someone who knows how to open new windows in different browsers should check this. --Alison Snieckus 13:37, 13 March 2010 (UTC))

  • Review and update the FAQs based on our experiences of Learning4Content
  • Final language edit.

(Comment.gif: Tutorial has been reordered and most of the text has been reworked for RTE. Rob Kruhlak 07:48, 10 February 2010 (UTC))

Tutorial 6: Images and Media

Estimated time: 5 hours (Comment.gif: Have cut out the Media part of the tutorial and will put it in a new intermediate tutorial. Rob Kruhlak 07:21, 3 December 2009 (UTC))

  • Create new navigation template for the RTE tutorial version
  • Create new pages for RTE version of tutorial 6
  • Include a new subpage on licensing of images and where to find free images and how to search for free content images (we can only use GFDL, CC-BY, CC-BY-SA & PD images). Cover feature pulling images in from the wiki commons.
  • Home page
    • Insert short paragraph referencing free content licensing of images
    • Wayne: Try and source an audio recording from someone to talk about free images (perhaps someone from CC)
  • Basics
    • Review and update page for RTE
    • Incorporate screenshot(s) with labels for the new RTE interface
      • (Comment.gif: Moved gallery section to the Tips page because there is no gallery button on the RTE toolbar.)
      • (Comment.gif: With the new "Upload file" page...although it's not coming up consistently for me...we will need to change the section on uploading an image from your computer. With the new fields, this section will likely get longer. I think we should create a new page for this and spend some time helping people understand the choices to be made.--Alison Snieckus 00:45, 2 April 2010 (UTC))
  • Frames and Thumbnails
    • Review and update page for RTE
    • Incorporate screenshot(s) with labels for the new RTE interface
  • Other media
    • Review and update page for RTE (Comment.gif: Removed and will be added to an intermediate tutorial.)
    • Incorporate screenshot(s) with labels for the new RTE interface
    • Add subsection for <playmp3> feature -- as optional section -- consider new subpage in this tutorial for more advanced media. (Comment.gif: will be a new tutorial Rob Kruhlak 06:35, 5 December 2009 (UTC))
    • Add subsection for <flash> feature ---- consider new subpage in this tutorial for more advanced media. (Comment.gif: will be a new tutorial Rob Kruhlak 06:35, 5 December 2009 (UTC))
  • Screencast
    • Create new screencast using RTE
  • Tips
    • Review and update tips page.
    • Include subsection on alternative to use {{Clear}} -- note that templates have not been covered yet, so we need to link to the tutorial with a note saying templates are covered later. Still need to verify the link to template tutorial. Rob Kruhlak 06:35, 5 December 2009 (UTC)
  • FAQs
  • Final language edit.

(Comment.gif: I split the Image and Media tutorial for a workshop I ran in July. The images and media tutorials were put together at the last minute. In the media tutorial there are subpages for flash and audio that could be used as a starting point for the RTE versions. Let me know if you think this might be a useful way to go.)

(Comment.gif: Add a subsection on embedding MediaWiki commons images using the "local" image syntax?)

I think that's a sensible split --- we must just keep the generic format with an intro on the tutorial's landing page. --Wayne Mackintosh 23:39, 21 October 2009 (UTC)

Tutorial 7: Collaborative Editing

Estimated time: 3 hours

  • Create new navigation template for the RTE tutorial version
  • Create new pages for RTE version of tutorial 7
  • Home page
    • Review content
    • Need better introduction --- This is a tutorial about tools and features for monitoring collaborative editing and tracking edits in the wiki. Need to introduce learners to the features that will be covered in the tutorial.
  • Recent changes
    • Review text
    • Insert screenshot of where to find the recent changes link
    • Insert screenshot of the recent changes page with a few labels showing most useful elements on the recent changes page
  • Diff and History
    • Review -- no major changes anticipated
    • (Comment.gif: in reviewing the content, it seems that the term "diff" is no longer used on the "Differences in revisions" page. The screen shot shows the term "previous diff" but the current screen uses the term "Older edit". I suggest rewriting this page to use the term "Difference between revisions" rather than "diff", updating the version comparison image and offering instruction on how to page through a set of edits using "Older edit" and "Newer edit".)
  • Reverting
    • Review -- no major changes anticipated
  • Screen cast
    • Existing screen cast looking at the Diff is fine
    • Need a new sceencast for demonstrating a revert -- with the RTE interface for saving the revision.
  • Summary and FAQs
    • Review page
    • Insert new FAQs based on our experiences of Learning4Content
    • Remove comments which are better suited to the talk page rather than the tutorial itself -- also WE is different from WP insofar as NPOV is concerned -- we're not developing encyclopaedia articles.
  • Final language edit.

Tutorial 8: Communication and interaction

Estimated time: 1 hour

  • Create new navigation template for the RTE tutorial version
  • Create new pages for RTE version of tutorial 8
  • Leave pages regarding Discussion pages for the time being --- until we get latest versions of LQT installed and sorted.
  • Talk pages
    • Leave for the time being.
  • Useful feature
    • Review and update page
    • Do we need to add any other useful features?
  • Screencast
    • Screencast is fine -- but add alternative method of adding page to a Watchlist by clicking the radio button before saving in edit view. Use the RTE edit window for this screencast edition.
      • Alternate adding to watchlist screen movie created and uploaded. New page for screen movie created and navigation updated. Rob Kruhlak 21:19, 15 February 2010 (UTC)
  • Final language edit (for pages updated).

Tutorial 9: Pedagogical Templates

Estimated time: 3 hours

  • Create new navigation template for the RTE tutorial version
  • Create new pages for RTE version of tutorial 9
  • Home page
    • Review and update page (Comment.gif: Helena, can you update the text in the Media template and possibly the audio?)
    • Consider replacing image with a screenshot illustrating Pedagogical Templates on a page
  • Template syntax
    • Review and update for inserting template syntax using RTE
    • Incorporate screen shots for how templates are displayed in the editing view and a label for the template icon in the RTE.
    • Include link to pdf cheatsheet for pedagogical templates
  • Examples
    • Review and update examples page for use with RTE
  • Add new subsection for Customisations of templates, eg alternate titles, inserting template in TOC etc.
    • Check for functionality of print versions of these template features -- currently breaking during rendering when using these additional parameters.
  • Screencast
    • Create new screencast using RTE for inserting template syntax.
  • Summary and FAQs
    • Review and update FAQs
  • Final language edit.

(Comment.gif: Functionality check could be time consuming if things have gone off track in the new version of the pdf extension. See note in general items section.)

Agreed -- lets drop this for the current iteration. We can tackle this at a later date. --Wayne Mackintosh 23:40, 21 October 2009 (UTC)

Tutorial 10: Thinking about structure

Estimated Time: 4 hours

  • Create new navigation template for the RTE tutorial version
  • Create new pages for RTE version of tutorial 9
  • Home page
    • Review page
    • Create links to Tutorial on Navigation templates. (Comment.gif: Currently linked to a help page on Navigational templates as a full blown tutorial has not been written. Rob Kruhlak 08:09, 26 November 2009 (UTC))
  • Subpages
    • Review and update page for using with RTE
    • Incorporate screenshot with labels
  • Navigation templates
    • Suggest removing this subsection from this tutorial --- embed an appropriate reference and link on the Subpages page. Skills required for navigation templates are too advanced for this level of tutorial. We'll shift this over to the intermediate level tutorials.

(Comment.gif: Navigational templates removed. Replace with a subpage explaining the previous and next links. Still needs to be modified for RTE Rob Kruhlak 07:38, 26 November 2009 (UTC))

  • Categories
    • Review in the light of the styles workgroup and progress on Categories
    • Update section for inserting categories using the RTE
    • We will need a more detailed tutorial to be developed for Categories. The page in this tutorial should be an introduction.
  • Summary and FAQs
    • Review and update (Comment.gif: Added previous and next subpage based on FAQ. Cleared FAQs Rob Kruhlak 08:38, 28 November 2009 (UTC))
    • Insert FAQs based on our experience of L4C.
  • Create screencast showing how to create a subpage using RTE and insert a subpage for the movie.
  • Final language edit.