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

From Polyglot Club WIKI
Jump to navigation Jump to search
(39 intermediate revisions by the same user not shown)
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]


==Headings==
==How to organize a lesson==


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


Use Heading2 (h2) and within each Heading2, you can use Headings3 (h3) and so on: Heading4, Heading5 etc...
To organize your lesson, and for [https://en.wikipedia.org/wiki/Search_engineoptimization SEO (Search engine optimization)], it is good to add title and different levels of headings.
===Title===
Do not use Heading1 for your lesson title 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 you want to write a title for your lesson, we suggest you add the following code instead:
Here is an example of page structure (using the Edit Source button)
 
'''<code><nowiki><div style="font-size:300%;"> TITRE </div></nowiki></code>'''
 
===h2===
For h2, use the following code :
'''<code>==Vocabulary==</code>'''
===h3===
For h3, use the following code:
 
'''<code>===The farm animals===</code>'''
 
Here are some useful markups :
 
==Page Structures Example==
 
Here is an example of page structure:


{| class="wikitable"  
{| class="wikitable"  
Line 50: Line 31:
(image)
(image)


'''<code><nowiki><div style="font-size:300%;">Vocabulary for animals in English</div></nowiki></code>''' (title of the page)
'''<code><nowiki><div style="font-size:300%;">Vocabulary for animals in English</div></nowiki></code>''' (Lesson title)


'''<code>==Vocabulary==</code>'''(h2)
'''<code>==Vocabulary==</code>'''(level 1)


'''<code>===The farm animals===</code>'''(h3)  
'''<code>===The farm animals===</code>'''(level 2)  


'''<code> ===Pets=== </code>'''(h3)
'''<code> ===Pets=== </code>'''(level 2)  


'''<code>==Expressions== </code>'''(h2)
'''<code>==Expressions== </code>'''(level 1)


'''<code>==Videos== </code>'''(h2)
'''<code>==Videos== </code>'''(level 1)
|}
|}


Line 68: Line 49:
*[[Language/Japanese/Vocabulary/Family]]
*[[Language/Japanese/Vocabulary/Family]]
*[[Language/French/Vocabulary/False-Friends]]
*[[Language/French/Vocabulary/False-Friends]]
===Lesson title===
If you want to write a title for your lesson, USE the following code:
'''<code><nowiki><div style="font-size:300%;"> TITLE </div></nowiki></code>'''
Important: do not use the heading level 1 code:
'''<strike><code>=TITLE=</code></strike>'''
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 Heading level 1 per page (for SEO reasons).
===Heading level 2===
Use the following code :
'''<code>==Vocabulary==</code>'''
===Heading level 3===
Use the following code:
'''<code>===The farm animals===</code>'''


==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 tables without having to use the wiki code or the visual editor:
===Create a table: Solution1===
 
#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
#Edit the wiki page with the "Edit source" tab
#Paste the code


===Create a table: Solution2===
===Create a table: Solution 1===
#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 90: Line 89:
<code>{| class="wikitable sortable"</code>
<code>{| class="wikitable sortable"</code>
if you want to make it sortable
if you want to make it sortable
===Create a table: Solution 2===
#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
#Edit the wiki page with the "Edit source" tab
#Paste the code


===Update a table===
===Update a table===
Line 96: Line 104:
#Edit your table in Excel
#Edit your table in Excel


Then update the wiki page, using solution 1 or 2 above
Then update the wiki page, using solution 1 or 2 above.
 
 
===How to format the table header===
The table header is a row at the top of the table that helps identify the rows below.
 
Here is how to create a table header:
 
Edit the page with the Edit source button:
*replace the following wiki code (only the first line)  :
 
<code><nowiki>{| class="wikitable"</nowiki></code>
 
<code><nowiki>|header title 1</nowiki></code>
 
<code><nowiki>|header title 2</nowiki></code>
 
<code><nowiki>|-</nowiki></code>
 
*with this code :
 
<code><nowiki>{| class="wikitable"</nowiki></code>
 
<code><nowiki>!header title 1</nowiki></code>


<code><nowiki>!header title 2</nowiki></code>
<code><nowiki>|-</nowiki></code>
You just have, '''ONLY on the first line''', to replace the <code>'''|'''</code> by a <code>'''!'''</code>


==  Links==
==  Links==
Line 112: Line 149:


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


==  Images ==
==  Images ==
Line 125: Line 163:


<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''
== Audio ==
See this page:
https://polyglotclub.com/wiki/Help/How-to-add-audio-files


== Videos ==
== Videos ==
To add a Youtube video, simply circle the video ID like this:
To add an '''embedded youtube video''' inside a lesson, click the '''EDIT CODE''' button.
 
Then, simply circle the video ID like this:


'''<code><nowiki> <youtube>[ID code]</youtube></nowiki></code>'''
'''<code><nowiki> <youtube>[ID code]</youtube></nowiki></code>'''
Line 190: Line 238:
#item 2
#item 2
##item 21
##item 21
==HTML and CSS==
If you know html and css languages, you can do almost any formatting like in the following lesson:
https://polyglotclub.com/wiki/Language/English/Culture/Find-the-Ideal-Penpal





Revision as of 12:18, 24 December 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.

How to organize a lesson

How should you organize your lesson?

To organize your lesson, and for SEO (Search engine optimization), it is good to add title and different levels of headings.

Here is an example of page structure (using the Edit Source button)

(image)

<div style="font-size:300%;">Vocabulary for animals in English</div> (Lesson title)

==Vocabulary==(level 1)

===The farm animals===(level 2)

===Pets=== (level 2)

==Expressions== (level 1)

==Videos== (level 1)


Here are examples of existing lessons to inspire you:


Lesson title

If you want to write a title for your lesson, USE the following code:

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


Important: do not use the heading level 1 code:

=TITLE= 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 Heading level 1 per page (for SEO reasons).

Heading level 2

Use the following code :

==Vocabulary==

Heading level 3

Use the following code:

===The farm animals===

Tables

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


Create a table: Solution 1

  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


Create a table: Solution 2

  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


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.


How to format the table header

The table header is a row at the top of the table that helps identify the rows below.

Here is how to create a table header:

Edit the page with the Edit source button:

  • replace the following wiki code (only the first line)  :

{| class="wikitable"

|header title 1

|header title 2

|-

  • with this code :

{| class="wikitable"

!header title 1

!header title 2

|-


You just have, ONLY on the first line, to replace the | by a !

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


Audio

See this page:

https://polyglotclub.com/wiki/Help/How-to-add-audio-files


Videos

To add an embedded youtube video inside a lesson, click the EDIT CODE button.

Then, 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

HTML and CSS

If you know html and css languages, you can do almost any formatting like in the following lesson: https://polyglotclub.com/wiki/Language/English/Culture/Find-the-Ideal-Penpal


More information about lists


Write a lesson: Why? How? FAQ