Editing Help/How-to-Write-a-Language-Lesson

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
{{Help-menu}}
{{Help-menu}}
<div class="pg_page_title">How to create a language learning lesson</div>
 
<span style="font-size:150%">'''Here are some tips to help you create a language learning lesson:'''</span>


The Wiki page editing is done thanks to the [https://www.mediawiki.org MediaWiki Engine], the software used by the famous [https://www.wikipedia.org Wikipedia].
The Wiki page editing is done thanks to the [https://www.mediawiki.org MediaWiki Engine], the software used by the famous [https://www.wikipedia.org Wikipedia].
Line 7: Line 8:
You have two options:
You have two options:
===  Visual Editor ===
===  Visual Editor ===
If you are new at Wiki page editing, we recommend using the visual editor which is a [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] editor.
If you are new at Wiki page editing, we recommend using the visual editor. It is an editor [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] who is proposed by default.
 
Click the Actions > '''Edit''' button.


Creating pages is intuitive with the various buttons to format the text.
Creating pages is intuitive with the various buttons to format the text.
Line 17: Line 16:
===  Wiki Code ===
===  Wiki Code ===
If you have a little more experience, we advise you to directly use the Wiki code because you have more formatting options.
If you have a little more experience, we advise you to directly use the Wiki code because you have more formatting options.
Click the Actions > '''Edit Source''' button.


*[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]


==How to organize a lesson==
== Useful Wiki Codes==
 
How should you organize your lesson?
 
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.
 
Here is an example of page structure (using the Edit Source button)
 
{| class="wikitable"
  |
(image)
 
'''<code><nowiki><div class="pg_page_title">Vocabulary for animals in English</div></nowiki></code>''' (Lesson title)
 
'''<code>==Vocabulary==</code>'''(level 1)
 
'''<code>===The farm animals===</code>'''(level 2)
 
'''<code> ===Pets=== </code>'''(level 2)
 
'''<code>==Expressions== </code>'''(level 1)
 
'''<code>==Videos== </code>'''(level 1)
|}
 
Here are examples of existing lessons to inspire you:
 
*[[Language/Japanese/Vocabulary/Family]]
*[[Language/French/Vocabulary/False-Friends]]
 
 
===Lesson title===
If you want to write a title for your lesson, USE the following code:
 
'''<code><nowiki><div class="pg_page_title"> 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>'''
 
===How to create headings with the visual editor===
 
Here is a video on how to create headings and automatically add a table of content:
 
https://www.youtube.com/watch?v=l2Ebiw4-OrQ
 
==Tables==
Here are easy ways to create tables without having to use the wiki code or the visual editor:
===Create a table: Solution 1===
#Create the table in Excel
#Copy and Paste the table in the page with the Visual Editor mode.
#Save the page
#Edit the page, this time, with the "Edit source" tab
#At the top of the table, add the following code, this will make your table much nicer
Replace the line :
<code>{|</code>
By the line :
<code>{| class="wikitable"</code>
Or by the line :
<code>{| class="wikitable sortable"</code>
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===
#Copy the table from the html page
#Paste in Excel
#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 special row at the top of the table with the title of each column.
 
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>
 
===Cool! you can also use HTML code 😉===
If you prefer HTML, you can use it to create tables.
 
Don't forget to use the class="wikitable" in the table opening tag so the table will look nice.
 
<code><nowiki><table </nowiki>'''class="wikitable"'''<nowiki>></nowiki></code>
 
  <code><nowiki><tr></nowiki></code>
 
    <code><nowiki><td>ligne 1, column 1</td></nowiki></code>
 
    <code><nowiki><td>ligne 1, column 2</td></nowiki></code>
 
  <code><nowiki></tr></nowiki></code>
 
  <code><nowiki><tr></nowiki></code>
 
    <code><nowiki><td>ligne 2, column 1</td></nowiki></code>
 
    <code><nowiki><td>ligne 2, column 2</td></nowiki></code>
 
    <code><nowiki></tr></nowiki></code>


<code><nowiki></table></nowiki></code>
Here are some useful markups :


==  Links==
===  Links=== 
===Internal links===
====Internal links====
To link to a page which URL is <code><nowiki>https://polyglotclub.com/wiki/</nowiki>'''Language/English/Grammar/To-be'''</code> inside the Polyglot club wiki, use the following code:
To link to a page which URL is wiki/Help inside the Polyglot club wiki, use the following code:


<code><nowiki>[[Language/English/Grammar/To-be|different text]]</nowiki></code>
<code><nowiki>[[Help|different text]]</nowiki></code>


===External links===
====External links====
To link to a page outside Polyglot club wiki.
To link to a page outside Polyglot club wiki.


Line 173: Line 36:
*[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?]
*To upload an image, see this link: [http://polyglotclub.com/wiki/Help/Upload-a-Photo-How How to upload and format a photo?]


Example:
Example:
Line 187: Line 49:
<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''


==Voice Recordings (AUDIO, MP3 etc.)==
===  Videos ===
See this page:
To add a Youtube video, simply circle the video ID like this:
 
'''<code><nowiki> <youtube>[ID code]</youtube></nowiki></code>'''
 
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:  


https://polyglotclub.com/wiki/Help/How-to-add-audio-files
'''<code><nowiki> <youtube> S4ypgbP2Jn4 </youtube> </nowiki></code>'''


== Videos ==
the video appears as below:
To add an '''embedded youtube video''' inside a lesson, click the '''EDIT CODE''' button.


Then, simply circle the video URL like this:
<Youtube>S4ypgbP2Jn4</youtube>


'''<code><nowiki> <youtube>[video URL]</youtube></nowiki></code>'''
===Audio MP3 files===


When writing a lesson to learn a language, it is cool to be able to add, next to a word, a small MP3 player to hear the pronunciation of that word.


===Example===
Better an example than a long explanation:


if the URL is as follows: '''https://www.youtube.com/watch?v=S4ypgbP2Jn4'''
[[File:alligator.png]]


use the following code:
'''Alligator'''


'''<code><nowiki> <youtube>https://www.youtube.com/watch?v=S4ypgbP2Jn4</youtube> </nowiki></code>'''
<player>alligator-english.mp3</player>


the video will appears as below:
To know how to do this, read [[Help/How-to-add-audio-files|THIS PAGE]].
<hr>
<youtube>S4ypgbP2Jn4</youtube>
<hr>


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


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


Line 223: Line 94:
*item 1
*item 1
*item 2
*item 2
 
==== Bullet with 2====
=== Bullet list 2===
<code><nowiki>*item 1</nowiki></code>
<code><nowiki>*item 1</nowiki></code>


Line 233: Line 103:
**item 12
**item 12


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


Line 242: Line 112:
:#item 2
:#item 2


===  Numbered List 2===
*[https://www.mediawiki.org/wiki/Help:Lists More information about lists]
<code><nowiki>#item 1</nowiki></code>


<code><nowiki>##item 12</nowiki></code>
===Headings===


<code><nowiki>#item 2</nowiki></code>
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...


<code><nowiki>##item 22</nowiki></code>
Use Heading2 (h2) and within each Heading2, you can use Headings3 (h3) and so on: Heading4, Heading5 etc...


The result is as followed:
Do not use Heading1 because this heading is already used for the page title and we can have only one Heading1 per page.
#item 1
 
##item 12
For h2, use the following code :
#item 2
##item 21
'''<code>==Vocabulary== </code>'''
 
For h3, use the following code:
 
'''<code>===The farm animals===</code>'''
 
===Tables===
 
An easy way to create tables without having to use the wiki code which can be confusing is to:
 
#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)
#Save the page
#Edit the page, this time, with the "Edit source" tab
#At the top of the table, add the following code, this will make your table much nicer
Replace the line :
<code>{|</code>
By the line :
<code>{| class="wikitable"</code>
 
You can also, create your table in Excel and use this [http://tools.wmflabs.org/excel2wiki/index.php free tool]
 
==Page Structures Example==
 
Here is an example of page structure:
 
{| class="wikitable"
  |
 
(image)
 
'''Vocabulary for animals in English''' (title of the page in bold)
 
'''<code>==Vocabulary==</code>'''(h2)


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


[https://www.mediawiki.org/wiki/Help:Lists More information about lists]
'''<code> ===Pets=== </code>'''(h3)


==HTML and CSS==
'''<code>==Expressions== </code>'''(h2)
If you know html and css languages, you can do many things like in the following lesson:
* https://polyglotclub.com/wiki/Language/English/Culture/Find-the-Ideal-Penpal


==Create your own page title==
'''<code>==Videos== </code>'''(h2)
* See this page: https://polyglotclub.com/wiki/Help/Create-your-own-Page-Title
|}


==You have more questions? Check the FAQ==
===Examples===
* Read more answers and ask questions [[Language/Multiple-languages/Culture/How-to-contribute-to-wiki-lessons-(FAQ)|here]].
Here are examples of existing lessons to inspire you:


*[[Language/Japanese/Vocabulary/Family]]
*[[Language/French/Vocabulary/False-Friends]]


<hr>
{{Help-menu}}
{{Help-menu}}

Please note that all contributions to Polyglot Club WIKI may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see PolyglotClub-WIKI:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)

Template used on this page:

Retrieved from "https://polyglotclub.com/wiki/Help/How-to-Write-a-Language-Lesson"