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}}
How to create a lesson to learn languages ​​on the Polyglot Club Wiki?
<div class="pg_page_title">How to create a language learning lesson</div>


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].


== What editor choose? ==
== What editor choose? ==
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.
 
Creating pages is so intuitive with the various buttons to format the text.


Click the Actions > '''Edit''' button.


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


*[https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide VisualEditor User Guide]
*[https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide VisualEditor User Guide]


===  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 in editing Wiki, 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?
Here are some useful markups :


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.
===  The Headers ===


Here is an example of page structure (using the Edit Source button)
===  The links=== 
====internal links====
Example: <nowiki>[[Main Page|different text]]</nowiki>


{| class="wikitable"
====external links====
  |
Example:  <nowiki>[https://mediawiki.org MediaWiki]</nowiki>
(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)
*[https://www.mediawiki.org/wiki/Help:Links More information about links]
 
'''<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>
===  Images ===
*[[Help/Upload-a-Photo-How|How to upload a photo?]]


===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.
*[https://www.mediawiki.org/wiki/Help:Images More information about images]


<code><nowiki><table </nowiki>'''class="wikitable"'''<nowiki>></nowiki></code>


  <code><nowiki><tr></nowiki></code>
===  Videos ===
To add a Youtube video, simply circle the video code like this: '''<nowiki> <youtube>[VIDEO CODE]</youtube></nowiki>'''


    <code><nowiki><td>ligne 1, column 1</td></nowiki></code>
The video code found inside the URL of a video on Youtube
 
    <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>
 
==  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:
 
<code><nowiki>[[Language/English/Grammar/To-be|different text]]</nowiki></code>
 
===External links===
To link to a page outside Polyglot club wiki.
 
<code><nowiki>[https://mediawiki.org MediaWiki]</nowiki></code>
 
*[https://www.mediawiki.org/wiki/Help:Links More information about links]
 
 
==  Images ==
*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:


<code><nowiki>[[File:My_pic.png|thumb|none]]</nowiki></code> ''Align left''
if the URL is as follows: '''https://www.youtube.com/watch?v=S4ypgbP2Jn4&app=desktop'''


[[File:Onomatopoeias.png|thumb|none]]
The code to copy is '''S4ypgbP2Jn4''' (between '''v =''' and '''&''')


<code><nowiki>[[File:My_pic.png|thumb]]</nowiki></code> ''Align right''
After inserting the code '''<nowiki> <youtube> S4ypgbP2Jn4 </ youtube> </ nowiki>''', the video appears as below:


<code><nowiki>[[File:My_pic.png|thumb|My Picture Caption]]</nowiki></code> ''with a caption''
<Youtube>S4ypgbP2Jn4</youtube>


==Voice Recordings (AUDIO, MP3 etc.)==
===Lists===
See this page:


https://polyglotclub.com/wiki/Help/How-to-add-audio-files
==== Bullet lists====
<nowiki>*item 1</nowiki>


== Videos ==
<nowiki>*item 2</nowiki>
To add an '''embedded youtube video''' inside a lesson, click the '''EDIT CODE''' button.


Then, simply circle the video URL like this:
The result is as followed:
*item 1
*item 2


'''<code><nowiki> <youtube>[video URL]</youtube></nowiki></code>'''


====  Numbered List ====


===Example===
<nowiki>:#item 1</nowiki>


if the URL is as follows: '''https://www.youtube.com/watch?v=S4ypgbP2Jn4'''
<nowiki>:#item 2</nowiki>


use the following code:  
The result is as followed:
:#item 1
:#item 2


'''<code><nowiki> <youtube>https://www.youtube.com/watch?v=S4ypgbP2Jn4</youtube> </nowiki></code>'''
*[https://www.mediawiki.org/wiki/Help:Lists More information about lists]


the video will appears as below:
<hr>
<youtube>S4ypgbP2Jn4</youtube>
<hr>


==Lists==
== Page Structure ==


=== Bullet list===
For your lesson more readable, we recommend the following structure
<code><nowiki>*item 1</nowiki></code>


<code><nowiki>*item 2</nowiki></code>
===  Image ===
===  Page Title ===
It's another formulation of the page title.


The result is as followed:
For example, if the title of the page is '''/French/Vocabulary/Animals''', you can have a title like : '''French Vocabulary for Animals'''.
*item 1
*item 2


=== Bullet list 2===
NB: The page title should not be a HEADING1 format. For [[https://en.wikipedia.org/wiki/Search_engine_optimization Search Engine Optimization]] reasons, it is advisable to use only one H1 tag per page.
<code><nowiki>*item 1</nowiki></code>


<code><nowiki>**item 12</nowiki></code>
An H1 tag is already automatically added by Mediawiki.


The result is as followed:
==Headings ==
*item 1
To organize your lesson, and for [[https://en.wikipedia.org/wiki/Search_engine_optimization SEO]], it is good to use different levels of headings.
**item 12
 
===  Numbered List ===
<code><nowiki>:#item 1</nowiki></code>
 
<code><nowiki>:#item 2</nowiki></code>
 
The result is as followed:
:#item 1
:#item 2


===  Numbered List 2===
Use Headings2 and withing each Headings2, you can use Headings3 and so on: Headings4, Headings5 etc ...
<code><nowiki>#item 1</nowiki></code>


<code><nowiki>##item 12</nowiki></code>
=== Examples ===
'''<Nowiki> == Vocabulary== </ nowiki>'''
'''<Nowiki> === The farm animals === </ nowiki>'''
'''<Nowiki> === Pets  === </ nowiki>'''


<code><nowiki>#item 2</nowiki></code>


<code><nowiki>##item 22</nowiki></code>
'''<Nowiki> == Example of use == </ nowiki>'''


The result is as followed:
#item 1
##item 12
#item 2
##item 21


'''<Nowiki> == Expressions using animal names == </ nowiki>'''


[https://www.mediawiki.org/wiki/Help:Lists More information about lists]


==HTML and CSS==
'''<Nowiki> == Videos  == </ nowiki>'''
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==
* See this page: https://polyglotclub.com/wiki/Help/Create-your-own-Page-Title


==You have more questions? Check the FAQ==
* Read more answers and ask questions [[Language/Multiple-languages/Culture/How-to-contribute-to-wiki-lessons-(FAQ)|here]].




<hr>
* [[Help / Create-your-own-Page-Name | How to create your own page name?]]
{{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"