Difference between revisions of "Help/How-to-Write-a-Language-Lesson"
(→Title) |
|||
(72 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Help-menu}} | {{Help-menu}} | ||
<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]. | ||
Line 9: | Line 8: | ||
=== 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 which is a [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] editor. | ||
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 16: | Line 17: | ||
=== 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== | ||
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> | '''<code>==Expressions== </code>'''(level 1) | ||
'''<code>==Videos== </code>'''(level 1) | |||
|} | |||
'''<code>== | |||
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: | |||
'''<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). | |||
'''<code> == | ===Heading level 2=== | ||
Use the following code : | |||
'''<code>==Vocabulary==</code>''' | |||
===Heading level 3=== | |||
Use the following code: | |||
'''<code>== | '''<code>===The farm animals===</code>''' | ||
===How to create headings with the visual editor=== | |||
Here | 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== | ==Tables== | ||
Here are easy ways to create | Here are easy ways to create tables without having to use the wiki code or the visual editor: | ||
===Create a table: | ===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 | #Copy and Paste the table in the page with the Visual Editor mode. | ||
#Save the page | #Save the page | ||
#Edit the page, this time, with the "Edit source" tab | #Edit the page, this time, with the "Edit source" tab | ||
Line 89: | Line 95: | ||
<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=== | ||
#Copy the table from the html page | #Copy the table from the html page | ||
Line 95: | Line 105: | ||
#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 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> | |||
== Links== | == Links== | ||
===Internal links=== | ===Internal links=== | ||
To link to a page which URL is wiki/ | 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=== | ===External links=== | ||
Line 111: | Line 172: | ||
*[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 124: | Line 186: | ||
<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.)== | |||
See this page: | |||
https://polyglotclub.com/wiki/Help/How-to-add-audio-files | |||
== Videos == | == Videos == | ||
To add a | To add an '''embedded youtube video''' inside a lesson, click the '''EDIT CODE''' button. | ||
''' | |||
Then, simply circle the video URL like this: | |||
'''<code><nowiki> <youtube>[video URL]</youtube></nowiki></code>''' | |||
===Example=== | |||
if the URL is as follows: '''https://www.youtube.com/watch?v=S4ypgbP2Jn4''' | |||
use the following code: | |||
'''<code><nowiki> <youtube>https://www.youtube.com/watch?v=S4ypgbP2Jn4</youtube> </nowiki></code>''' | |||
the video will appears as below: | |||
<hr> | |||
<youtube>S4ypgbP2Jn4</youtube> | <youtube>S4ypgbP2Jn4</youtube> | ||
<hr> | |||
==Lists== | ==Lists== | ||
Line 193: | Line 260: | ||
[https://www.mediawiki.org/wiki/Help:Lists More information about lists] | [https://www.mediawiki.org/wiki/Help:Lists More information about lists] | ||
==HTML and CSS== | |||
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-menu}} | {{Help-menu}} |
Latest revision as of 15:33, 2 June 2022
Write a lesson: Why? | How? | FAQ |
The Wiki page editing is done thanks to the MediaWiki Engine, the software used by the famous Wikipedia.
What editor choose?[edit | edit source]
You have two options:
Visual Editor[edit | edit source]
If you are new at Wiki page editing, we recommend using the visual editor which is a WYSIWYG editor.
Click the Actions > Edit button.
Creating pages is intuitive with the various buttons to format the text.
Wiki Code[edit | edit source]
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.
How to organize a lesson[edit | edit source]
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)
|
Here are examples of existing lessons to inspire you:
Lesson title[edit | edit source]
If you want to write a title for your lesson, USE the following code:
<div class="pg_page_title"> TITLE </div>
Important: do not use the heading level 1 code:
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).
=TITLE=
Heading level 2[edit | edit source]
Use the following code :
==Vocabulary==
Heading level 3[edit | edit source]
Use the following code:
===The farm animals===
How to create headings with the visual editor[edit | edit source]
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[edit | edit source]
Here are easy ways to create tables without having to use the wiki code or the visual editor:
Create a table: Solution 1[edit | edit source]
- 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 :
{|
By the line :
{| class="wikitable"
Or by the line :
{| class="wikitable sortable"
if you want to make it sortable
Create a table: Solution 2[edit | edit source]
- Create your table in Excel
- Use this 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[edit | edit source]
- 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[edit | edit source]
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) :
{| 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 !
Cool! you can also use HTML code 😉[edit | edit source]
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.
<table class="wikitable">
<tr>
<td>ligne 1, column 1</td>
<td>ligne 1, column 2</td>
</tr>
<tr>
<td>ligne 2, column 1</td>
<td>ligne 2, column 2</td>
</tr>
</table>
Links[edit | edit source]
Internal links[edit | edit source]
To link to a page which URL is https://polyglotclub.com/wiki/Language/English/Grammar/To-be
inside the Polyglot club wiki, use the following code:
[[Language/English/Grammar/To-be|different text]]
External links[edit | edit source]
To link to a page outside Polyglot club wiki.
[https://mediawiki.org MediaWiki]
Images[edit | edit source]
- To upload an image, see this link: How to upload and format a photo?
Example:
[[File:My_pic.png|thumb|none]]
Align left
[[File:My_pic.png|thumb]]
Align right
[[File:My_pic.png|thumb|My Picture Caption]]
with a caption
Voice Recordings (AUDIO, MP3 etc.)[edit | edit source]
See this page:
https://polyglotclub.com/wiki/Help/How-to-add-audio-files
Videos[edit | edit source]
To add an embedded youtube video inside a lesson, click the EDIT CODE button.
Then, simply circle the video URL like this:
<youtube>[video URL]</youtube>
Example[edit | edit source]
if the URL is as follows: https://www.youtube.com/watch?v=S4ypgbP2Jn4
use the following code:
<youtube>https://www.youtube.com/watch?v=S4ypgbP2Jn4</youtube>
the video will appears as below:
Lists[edit | edit source]
Bullet list[edit | edit source]
*item 1
*item 2
The result is as followed:
- item 1
- item 2
Bullet list 2[edit | edit source]
*item 1
**item 12
The result is as followed:
- item 1
- item 12
Numbered List[edit | edit source]
:#item 1
:#item 2
The result is as followed:
- item 1
- item 2
Numbered List 2[edit | edit source]
#item 1
##item 12
#item 2
##item 22
The result is as followed:
- item 1
- item 12
- item 2
- item 21
HTML and CSS[edit | edit source]
If you know html and css languages, you can do many things like in the following lesson:
Create your own page title[edit | edit source]
You have more questions? Check the FAQ[edit | edit source]
- Read more answers and ask questions here.
Write a lesson: Why? | How? | FAQ |