MoodleDocs talk:Transclusion

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 2.0. Up-to-date documentation for the latest stable version is available here: Transclusion.

Partial transclusion example

Lets see if the following texts can be inserted into other pages via transclusion.

This text is only part of the text that is located on MoodleDocs talk:Transclusion page. Only this text should appear when {{:MoodleDocs_talk:Transclusion}} is inserted into another page.This text is after the onlyinclude but on the same line and this text may appear.

This text should not appear.

Here is some text from my user page.

Recap of ideas going forward from 1.9 and 2.0

  • Create separate editions of MoodleDocs for each version (2.0, 2.1, 2.2) by copying the previous edition as the starting point for the new edition. In the past we had 1 edition (the current 1.9 edition) that could include information about 6 different versions of Moodle.
  • Assume that reader is looking at the version edition with a new install (don't worry about history).
    • If necessary, put a heading that explains the general difference between the previous edition and the current one to be friendly for those upgrading.
  • Note that the transition from 1.9 edition to 2.0 (and 2.1 and perhaps 2.2) will be rough
    • It is desirable to delete or edit out references to previous versions (starting with the 2.0 edition going forward)
    • Move "Notes" from outline to specific Talk: page and change banner to {{Improve}}
    • Identify "Heavy Lifting pages, those that need major format changes or a set of pages on a common subject that have become muddled (need to be refocused)
  • There are basically two sets of readers of these editions that share a common interest in the operation of Moodle site: Teachers and site administrators. They have different concerns but also have areas that overlap.
    • A feature used by a teacher might have a standard minimum set of 4 pages links on a template:
Overview, Settings, Uses and FAQs
    • It is important that a teacher know that site settings can impact what they see. This can be a section on the settings page with a brief description that includes links to pages used by site administrators.
    • Likewise, a site administration setting should have links to the overview page or settings page that a teacher uses.
  • In the transition in removing the rough edges, we will work on 2.0 and delay the creation of the 2.1 edition until 2.2 is released.
    • This may create minor problems at the first real split when essentially we will copy the 2.0 to both a 2.1 edition and (perhaps with a slight delay to) a 2.2 edition.
  • Towards the end of the process of removing most of the rough edges in the "new edition", we then need to focus some energy upon encouraging our community to contribute to MoodleDocs via editing.

The above notes are to myself after a conversation with Helen Foster, who got an overview from Martin and Thomaz (who put in a lot of work and research about MoodleDoc (re)organization, thank you very much). The above notes are just general guidelines and will no doubt gently change over time as Moodle continues to change.--chris collman 20:12, 25 August 2011 (WST)


History if you are interested

In 2006 I started contributing to MoodleDocs as a way to learn the software. I stepped intense editing in July 2010 because of additional work and family commitments. Looks like I am back with the same motivation.

This summer (July-Aug 2011), I was given the task to build a few webservers for our internal LAN (intranet).

Our use of the application is simple. We do tests, have people download pdfs and fill out questionnaires. I decided that I might as well install 2.1. Our previous servers were 1.5.x Moodles :) We upgraded a 1.5 Moodle server to 1.9 last summer this is a bit more ambitious.

I will be adding a custom language (a version of AmericanSpeak), building 50 exams, 30 questionnaires and uploading 100 or so PDF files as resources. Then I will do the same thing x3 again and then x2 again and perhaps again.

MoodleDocs 2.0 self professed goals

  • Make sure the menu paths are for Moodle 2.0
  • Stick with technical how tos, encourage practical examples for teachers
  • Add some images that are annotated with numbers for references
  • Remember English pages are read/translated by non-native speakers
  • After editing for 2.0, delete detail instructions for 1.9 replace them with links to a 1.9 page
  • Delete opinions and sales pitches for Moodle 2.0
  • Identify Tips and Notes, so the "impatient" can skim.
  • Pay attention to the way others edit my words so I can improve my style

Noble goals.

Best to all, Chris --chris collman 20:21, 19 July 2011 (WST)

TIP 2: I could not insert a whole section from my user page called Test by using the # sign.

{{:User:chris collman/sandbox2#Test1}} put the whole page. Need markups

TIP 3: I could insert multiple onlyinclude markups and pick out selected text in a targeted page.

Cool beans! I think he has got it..The rain in Spain falls mainly on the plains! Just crawl, not run, towards the KISS --chris collman 06:57, 5 December 2008 (CST)

Ideas

  • This can create footers and headers without use of special wikimedia CSS formats. I like the footer banner kind of idea but I know it can give a cluttered look.--chris collman 08:21, 5 December 2008 (CST)
  1. Create a new FAQ namespace.
  2. In this namespace, create one page for each frequent question, where the contents of the page is the answer.
  3. Use our new knowledge of transclusions to build the FAQ lists by just pulling in pages from the FAQ namespace.

The benefits of doing this are

  • The same FAQ can appear in more than one list without copying-and-pasting.
  • Each question gets a unique URL that so in the forums, we can point people to a page that just answers their specific question.

Disadvantages

  • Editing FAQ lists becomes incomprehensible to anyone who is not a MediaWiki geek.

If we went this way, I would like to use B to build a new FAQ page: "Troubleshooting FAQ". Might be a good idea anyway. --Tim Hunt 07:11, 4 December 2008 (CST)