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

From Polyglot Club WIKI
Jump to navigation Jump to search
(Created page with "How to create a lesson to learn languages ​​on the Polyglot Club Wiki? The Wiki page editing is done thanks to the [https://www.mediawiki.org MediaWiki Engine], the softw...")
 
 
(202 intermediate revisions by 2 users not shown)
Line 1: Line 1:
How to create a lesson to learn languages ​​on the Polyglot Club Wiki?
{{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].


== 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. It is an editor [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] who is proposed by default.
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.
 
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 ===
If you have a little more experience, we advise you to directly use the Wiki code because you have more formatting options.


===  Wiki Code ===
Click the Actions > '''Edit Source''' button.
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.


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


Here are some useful markups :
<code><nowiki>|-</nowiki></code>


===  The Headers ===
*with this code :


===  The links=== 
<code><nowiki>{| class="wikitable"</nowiki></code>
====internal links====
Example: <nowiki>[[Main Page|different text]]</nowiki>


====external links====
<code><nowiki>!header title 1</nowiki></code>
Example:  <nowiki>[https://mediawiki.org MediaWiki]</nowiki>


<code><nowiki>!header title 2</nowiki></code>


<code><nowiki>|-</nowiki></code>


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


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==
===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:


===  Images ===
<code><nowiki>[[Language/English/Grammar/To-be|different text]]</nowiki></code>
*[[Help/Upload-a-Photo-How|How to upload a photo?]]


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


*[https://www.mediawiki.org/wiki/Help:Images More information about images]
<code><nowiki>[https://mediawiki.org MediaWiki]</nowiki></code>


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


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


The video code found inside the URL of a video on Youtube
==  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:


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


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


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


<nowiki>*item 2</nowiki>
Then, simply circle the video URL like this:


The result is as followed:
'''<code><nowiki> <youtube>[video URL]</youtube></nowiki></code>'''
*item 1
*item 2




====  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:
'''<code><nowiki> <youtube>https://www.youtube.com/watch?v=S4ypgbP2Jn4</youtube> </nowiki></code>'''
:#item 1
:#item 2


*[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===
<code><nowiki>*item 1</nowiki></code>


For your lesson more readable, we recommend the following structure
<code><nowiki>*item 2</nowiki></code>


===  Image ===
The result is as followed:
===  Page Title ===
*item 1
It's another formulation of the page title.
*item 2


For example, if the title of the page is '''/French/Vocabulary/Animals''', you can have a title like : '''French Vocabulary for Animals'''.
=== Bullet list 2===
<code><nowiki>*item 1</nowiki></code>


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 12</nowiki></code>


An H1 tag is already automatically added by Mediawiki.
The result is as followed:
*item 1
**item 12
 
===  Numbered List ===
<code><nowiki>:#item 1</nowiki></code>
 
<code><nowiki>:#item 2</nowiki></code>


==Headings  ==
The result is as followed:
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 1
:#item 2


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


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


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


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


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]


'''<Nowiki> == Videos  == </ nowiki>'''
==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]].




* [[Help / Create-your-own-Page-Name | How to create your own page name?]]
<hr>
{{Help-menu}}

Latest revision as of 15:33, 2 June 2022

Write a lesson: Why? How? FAQ
How to 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?[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)

<div class="pg_page_title">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[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:

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

  1. Create the table in Excel
  2. Copy and Paste the table in the page with the Visual Editor mode.
  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[edit | edit source]

  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[edit | edit source]

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

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

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:

  1. item 1
  2. item 2

Numbered List 2[edit | edit source]

#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


More information about lists

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