Difference between revisions of "Help/How-to-Write-a-Language-Lesson"

From Polyglot Club WIKI
Jump to navigation Jump to search
Line 19: Line 19:
*[https://www.mediawiki.org/wiki/Help:Formatting How to use the wiki code]
*[https://www.mediawiki.org/wiki/Help:Formatting How to use the wiki code]


== Useful Wiki Codes==


===Headings===
==Headings==


To organize your lesson, and for [https://en.wikipedia.org/wiki/Search_engineoptimization Search engine optimization], it is good to use different levels of headings: h2, h3...
To organize your lesson, and for [https://en.wikipedia.org/wiki/Search_engineoptimization Search engine optimization], it is good to use different levels of headings: h2, h3...


Use Heading2 (h2) and within each Heading2, you can use Headings3 (h3) and so on: Heading4, Heading5 etc...
Use Heading2 (h2) and within each Heading2, you can use Headings3 (h3) and so on: Heading4, Heading5 etc...
====h1====
===h1===
Do not use Heading1 because this heading is already used automatically for the page title (the page title is the same as the title in the URL) and we can have only have one Heading1 per page (for SEO reasons).
Do not use Heading1 because this heading is already used automatically for the page title (the page title is the same as the title in the URL) and we can have only have one Heading1 per page (for SEO reasons).


Line 33: Line 32:
'''<code><nowiki><div style="font-size:300%;"> TITRE </div></nowiki></code>'''
'''<code><nowiki><div style="font-size:300%;"> TITRE </div></nowiki></code>'''


====h2====
===h2===
For h2, use the following code :
For h2, use the following code :
   
   
'''<code>==Vocabulary==</code>'''
'''<code>==Vocabulary==</code>'''
====h3====
===h3===
For h3, use the following code:
For h3, use the following code:


Line 44: Line 43:
Here are some useful markups :
Here are some useful markups :


===  Links=== 
====Internal links====
To link to a page which URL is wiki/Help  inside the Polyglot club wiki, use the following code:
<code><nowiki>[[Help|different text]]</nowiki></code>




===Page Structures Example===
==Page Structures Example==


Here is an example of page structure:
Here is an example of page structure:
Line 78: Line 72:
*[[Language/French/Vocabulary/False-Friends]]
*[[Language/French/Vocabulary/False-Friends]]


====External links====
==  Links==
===Internal links===
To link to a page which URL is wiki/Help  inside the Polyglot club wiki, use the following code:
 
<code><nowiki>[[Help|different text]]</nowiki></code>
 
 
===External links===
To link to a page outside Polyglot club wiki.
To link to a page outside Polyglot club wiki.


Line 85: Line 86:
*[https://www.mediawiki.org/wiki/Help:Links More information about links]
*[https://www.mediawiki.org/wiki/Help:Links More information about links]


===  Images ===
==  Images ==
*[http://polyglotclub.com/wiki/Help/Upload-a-Photo-How How to upload and format a photo?]
*[http://polyglotclub.com/wiki/Help/Upload-a-Photo-How How to upload and format a photo?]


Line 98: Line 99:
<code><nowiki>[[File:My_pic.png|thumb|My Picture Caption]]</nowiki></code> ''with a caption''
<code><nowiki>[[File:My_pic.png|thumb|My Picture Caption]]</nowiki></code> ''with a caption''


==Videos ===
== Videos ==
To add a Youtube video, simply circle the video ID like this:
To add a Youtube video, simply circle the video ID like this:


Line 119: Line 120:
<youtube>S4ypgbP2Jn4</youtube>
<youtube>S4ypgbP2Jn4</youtube>


===Lists===
==Lists==


==== Bullet list====
=== Bullet list===
<code><nowiki>*item 1</nowiki></code>
<code><nowiki>*item 1</nowiki></code>


Line 130: Line 131:
*item 2
*item 2


==== Bullet list 2====
=== Bullet list 2===
<code><nowiki>*item 1</nowiki></code>
<code><nowiki>*item 1</nowiki></code>


Line 139: Line 140:
**item 12
**item 12


====  Numbered List ====
===  Numbered List ===
<code><nowiki>:#item 1</nowiki></code>
<code><nowiki>:#item 1</nowiki></code>


Line 148: Line 149:
:#item 2
:#item 2


====  Numbered List 2====
===  Numbered List 2===
<code><nowiki>#item 1</nowiki></code>
<code><nowiki>#item 1</nowiki></code>


Line 167: Line 168:




===Tables===
==Tables==
Here are easy ways to create large tables without having to use the wiki code or the visual editor:
Here are easy ways to create large tables without having to use the wiki code or the visual editor:
====Create a table: Solution1====
===Create a table: Solution1===
#Create your table in Excel
#Create your table in Excel
#Use this [http://tools.wmflabs.org/excel2wiki/index.php free tool] to create the wiki code equivalent to your Excel table
#Use this [http://tools.wmflabs.org/excel2wiki/index.php free tool] to create the wiki code equivalent to your Excel table
Line 175: Line 176:
#Paste the code
#Paste the code


====Create a table: Solution2====
===Create a table: Solution2===
#Create the table in Excel
#Create the table in Excel
#Copy and Paste the table in the page with the Visual Editor mode (do not use the "Edit source" table but use the "Edit" table)
#Copy and Paste the table in the page with the Visual Editor mode (do not use the "Edit source" table but use the "Edit" table)
Line 189: Line 190:
if you want to make it sortable
if you want to make it sortable


====Update a table====
===Update a table===
#Copy the table from the html page
#Copy the table from the html page
#Paste in Excel
#Paste in Excel

Revision as of 21:38, 13 February 2019

Write a lesson: Why? How? FAQ

Here are some tips to help you create a language learning lesson:

The Wiki page editing is done thanks to the MediaWiki Engine, the software used by the famous Wikipedia.

What editor choose?

You have two options:

Visual Editor

If you are new at Wiki page editing, we recommend using the visual editor which is a WYSIWYG editor.

Creating pages is intuitive with the various buttons to format the text.

Wiki Code

If you have a little more experience, we advise you to directly use the Wiki code because you have more formatting options.


Headings

To organize your lesson, and for Search engine optimization, it is good to use different levels of headings: h2, h3...

Use Heading2 (h2) and within each Heading2, you can use Headings3 (h3) and so on: Heading4, Heading5 etc...

h1

Do not use Heading1 because this heading is already used automatically for the page title (the page title is the same as the title in the URL) and we can have only have one Heading1 per page (for SEO reasons).

If, anyway, you want to add another page title (h1), we suggest you add the following code instead:

<div style="font-size:300%;"> TITRE </div>

h2

For h2, use the following code :

==Vocabulary==

h3

For h3, use the following code:

===The farm animals===

Here are some useful markups :


Page Structures Example

Here is an example of page structure:

(image)

Vocabulary for animals in English (title of the page in bold)

==Vocabulary==(h2)

===The farm animals===(h3)

===Pets=== (h3)

==Expressions== (h2)

==Videos== (h2)


Here are examples of existing lessons to inspire you:

Links

Internal links

To link to a page which URL is wiki/Help inside the Polyglot club wiki, use the following code:

[[Help|different text]]


External links

To link to a page outside Polyglot club wiki.

[https://mediawiki.org MediaWiki]

Images

Example:

[[File:My_pic.png|thumb|none]] Align left

Onomatopoeias.png

[[File:My_pic.png|thumb]] Align right

[[File:My_pic.png|thumb|My Picture Caption]] with a caption

Videos

To add a Youtube video, simply circle the video ID like this:

<youtube>[ID code]</youtube>

The video [ID code] can be found inside the URL of a Youtube video.

Example:

if the URL is as follows: https://www.youtube.com/watch?v=S4ypgbP2Jn4&app=desktop

The code to copy is S4ypgbP2Jn4 (between v= and &)

After inserting the following code:

<youtube> S4ypgbP2Jn4 </youtube>

the video appears as below:

Lists

Bullet list

*item 1

*item 2

The result is as followed:

  • item 1
  • item 2

Bullet list 2

*item 1

**item 12

The result is as followed:

  • item 1
    • item 12

Numbered List

:#item 1

:#item 2

The result is as followed:

  1. item 1
  2. item 2

Numbered List 2

#item 1

##item 12

#item 2

##item 22

The result is as followed:

  1. item 1
    1. item 12
  2. item 2
    1. item 21


Tables

Here are easy ways to create large tables without having to use the wiki code or the visual editor:

Create a table: Solution1

  1. Create your table in Excel
  2. Use this free tool to create the wiki code equivalent to your Excel table
  3. Edit the wiki page with the "Edit source" tab
  4. Paste the code

Create a table: Solution2

  1. Create the table in Excel
  2. Copy and Paste the table in the page with the Visual Editor mode (do not use the "Edit source" table but use the "Edit" table)
  3. Save the page
  4. Edit the page, this time, with the "Edit source" tab
  5. At the top of the table, add the following code, this will make your table much nicer

Replace the line : {| By the line : {| class="wikitable" Or by the line : {| class="wikitable sortable" if you want to make it sortable

Update a table

  1. Copy the table from the html page
  2. Paste in Excel
  3. Edit your table in Excel

Then update the wiki page, using solution 1 or 2 above


Write a lesson: Why? How? FAQ