Wiki Tutorial: Difference between revisions

From XPUB & Lens-Based wiki
 
(44 intermediate revisions by 7 users not shown)
Line 1: Line 1:
=Wiki Intro=
'''For a more detailed page on Wikis, a historical perspective and some of its many possibilities see the [[Wiki]] page.
== A little history ==
'''
 
'''This page is more a how-to guide.'''
 
'''As it is a wiki, feel free to edit it.'''


The first wiki was create in 1995 by Ward Cunningham, and it was called Wiki Wiki Web (Wiki in Hawaii means quick!).
__TOC__


[http://upload.wikimedia.org/wikipedia/commons/3/31/Ward_Cunningham%2C_Inventor_of_the_Wiki.webm Interview with Ward Cunningham]
==Wiki editing==


Wikis are about '''speed and easiness of writing and publishing on the Web'''.  
Below you can find a '''cheatsheet''' with commonly used wikitext mark up.


Also about '''collaboration'''. According to Ward Cunningham ‘People discovered that they can create something with other people, that they don't even know. But they come to trust and they make something that surprises them in terms of its value’.
But first of all, it's good to know is that there are two editors that you can use to edit your text:


'''For a more detailed page on Wikis, its historical historical perspective and some of its many possibilities
===Visual editor===
see the [[Wiki]] page.
 
'''
* to use it, click <code>Edit</code>
* uses a WYSIWYG editor
* [https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide Visual editor user guide]


'''This page is more how-to guide.'''
===Wikitext editor===


'''As it is a wiki, feel free to edit it.'''
* to use it, click <code>Edit source</code>
* uses a specific mark up language: wikitext
* [https://www.mediawiki.org/wiki/Help:Formatting Wiki syntax user guide]


=Wiki editing=
==cheatsheet==
==account creation==
In order to start contributing to BS wiki, like in most wikis, you need to create a user account.
Do so by clicking on '''Create Account''', in the top right corner or the wiki,


You'll be taken to a page where you will be asked your account details, a question to see if you are not a robot — as you guessed the answer is ''Kooning''.


[[File:createaccountpage.png]]
<nowiki>''italics''
'''bold'''
'''''bold and italics'''''
==standard header==
===next-level header=== (...and so on)
[[Internal link]]
[[Internal link|alternate text]]
[http://example.com text of external link]
[[Category:Example]] (category tag)
[[:Category:Example]] (link to category)
---- (horizontal line)
* bulleted item
# numbered item
:indentation
::double indentation (...and so on)
;term : definition
[[File:Image-name.jpg|thumb|frame|Caption text]]
{{:Transcluded page name}}
{{Template name}} (call to template)
#REDIRECT [[Page name]]</nowiki>


==editing==
==editing==
Line 39: Line 81:


Once done editing <span style="background:yellow">'''save the page'''</span>, otherwise your contribution will be lost.  
Once done editing <span style="background:yellow">'''save the page'''</span>, otherwise your contribution will be lost.  
==text formating==
Although there is a specific syntax to format the text, you can use the menu to do much of the formating you need.
In case you are interested to get to know the syntax here is [http://www.mediawiki.org/wiki/Help:Formatting cheat-sheet] with the most important syntax. 
You can experiment with writing and formating your own '''User page'''. You can get go to this page by clicking in your username, next to the little person drawing. The user page, is normally used to say something about you, but can also be a nice testing ground.


'''Attention: to create line breaks you need to leave at least one empty space between one line of text and the next.'''
===Title Headings===
 
==Title Headings==
You can make titles with different hierarchic levels by using "=" as follows:
You can make titles with different hierarchic levels by using "=" as follows:


<nowiki>=Main Title=</nowiki>
<nowiki>=Main Title=</nowiki>


<nowiki>==Sub Title==</nowiki>
<nowiki>==Sub Title==</nowiki>


<nowiki>===Sub-sub Title===</nowiki>
<nowiki>===Sub-sub Title===</nowiki>


<nowiki>===Sub-sub-sub Title===</nowiki>
<nowiki>===Sub-sub-sub Title===</nowiki>


You can place content under each of these section
You can place content under each of these section


The result when the page is saved will be:
===page creation===
 
=Main Title=
Content under Main Title
==Sub Title==
Content under Sub Title
===Sub-sub Title===
Content under Sub-sub Title
===Sub-sub-sub Title===
Content under Sub-sub-sub Title
 
 
==page creation==
'''How to create a page?'''
'''How to create a page?'''


In a wiki the information is organized into pages or articles ( no great distinction between the two). If you want to say something about something for which there isn't a page, you create that page and start writing its content.  
In a wiki the information is organized into pages or articles ( no great distinction between the two). If you want to say something about something for which there isn't a page, you create that page and start writing its content.  
To create a page  create '''internal links''' <nowiki>[[name of new page]]</nowiki> for that page
To create a page  create '''internal links''' <nowiki>[[name of new page]]</nowiki> for that page


Line 95: Line 117:
[[oooooooo]] - an non-existing page
[[oooooooo]] - an non-existing page


==external links==
===Links===
To link to external webpages, use the '''world icon'''.
 
There are two kinds of links:
 
* internal (to another wiki page)
* external (to anything outside this wiki)
 
====internal links====
 
So, when you want to make a link to a page on this wiki:
 
<nowiki>[[name of page]]</nowiki>
 
For example a link to the Main Page looks like:
 
  <nowiki>[[Main Page]]</nowiki>
 
will result in: [[Main Page]]


You'll be presented with:
<span style="background:yellow">Note: these links are case sensitive.</span>
<nowiki>[http://www.example.com link title]</nowiki> and simply need to replace them with url and title(optional)


like:
====external links====


<nowiki>[http://beyond-social.org/ Beyond Social] </nowiki> == [http://beyond-social.org/ Beyond Social]
You can write external links in different ways:


==Audio-visuals==
Just by pasting a URL:


===uploading images===
<nowiki>https://xpub.nl/</nowiki>: https://xpub.nl/
 
Using link text:
 
<nowiki>[https://xpub.nl/ XPUB's website]</nowiki>: [https://xpub.nl/ XPUB's website]
 
Or as a "footnote"
 
<nowiki>[https://xpub.nl/]</nowiki>: [https://xpub.nl/]
 
==== red links ====
 
Significantly, wikis allow links to pages that do not (yet) exist. These are called "[[redlinks]]" (typically they appear in red to differentiate from "blue" normal links). In this was editors can write with links without knowing (or caring) if a given page exists. Redlinks can form a "potential page" or "todo" articles that when created in the future, will already be linked. Non-existent (redlink) Pages do display backlinks even before they are given any content (though they will not appear in [[Special:AllPages]], they can be seen via [[Special:WantedPages]])
 
===Audio-visuals===
 
====uploading images====
You probably want not only to write, but also to use images, audio and video on the pages you'll be developing.
You probably want not only to write, but also to use images, audio and video on the pages you'll be developing.


Line 124: Line 177:
'''To upload''' you can use the picture icon on the menu. It asks you for the file name of the file you are going to upload (they must match) and a caption, if you to say something about that image, video, or audio.  
'''To upload''' you can use the picture icon on the menu. It asks you for the file name of the file you are going to upload (they must match) and a caption, if you to say something about that image, video, or audio.  


When at this upload menu, <span style="background:yellow">instead of "caption" select "none" as the format of your upload</span>.
The syntax to insert an image:


<nowiki>[[File:myimage.png|My caption]]</nowiki>
<nowiki>[[File:myimage.png|My caption]]</nowiki>


Captions can be added to images by using a vertical bar (the "pipe"):


This action doesn't upload the file, it only inserts a bit syntax that allow you do the upload the file. In order to do so, you need to:
<nowiki>[[File:myimage.jpg|Caption under the image]] </nowiki>
* Save the page you are working on
* Click on the red link of the file you want to upload
* Follow the instruction to upload your file


[[File:myimage.png]]
====Audio====


===image captions===
Download the Widgets extension: https://www.mediawiki.org/wiki/Extension:Widgets
Captions can be added to images by using a vertical bar


<nowiki>[[File:myimage.jpg|Caption under the image]] </nowiki>
And copy the full content of this page to your wiki, in a page called "Widget:Audio": https://pzwiki.wdka.nl/mediadesign/Widget:Audio


====Video files====
Using <code><nowiki>{{#Widget:Video}}</nowiki></code>
This widget is configured on this page: [[Widget:Video]]
You can use it in this way:
<nowiki>
{{#Widget:Video|webm=http://url.to/your.webm|mp4=http://url.to/your.mp4|style=}}
</nowiki>
For example:
<nowiki>
{{#Widget:Video|mp4=https://pzwiki.wdka.nl/mw-mediadesign/images/a/af/Traffic_lights.mp4|style=height:200px;float:right;}}
</nowiki>
====Youtube/Vimeo videos====


===Youtube/Vimeo videos===
To include, you need:
To include, you need:
* the ID of the video you want to include in you page
* the ID of the video you want to include in you page
Line 153: Line 221:
{{youtube|UyCIB_ChlV0}}
{{youtube|UyCIB_ChlV0}}


{{youtube|A1YYv_J2csk}}


{{vimeo|68841788}}


{{youtube|A1YYv_J2csk}}
===Wiki calendar care===
Here's a link to how to add information to the calendar and what do you if it disappears.
 
[[Help the calendar disappeared]]


{{vimeo|68841788}}
===Changing page titles===


=Chaging pages' titles=
Pages' titles can be changed by using the function '''Move''' in the top right corner in a dropdown menu next to the star.
Pages' titles can be changed by using the function '''Move''' in the top right corner in a dropdown menu next to the star.


The Move page permits you to attribute a new name to the current page
The Move page permits you to attribute a new name to the current page. Move lets you effectively rename a page. By default, a move shifts content to the new title, and creates a redirect from the old title to the new one; in this way links to the old page will not break and will simply redirect to the correct page. In this way, a move is consistent with the wiki attitude of keeping history visible.
 
Move = (Copy and Paste) + (Redirect or Delete)
 
=== Deleting pages ===
 
Deleting a page is also possible. Note however that a delete is simply a way of marking that page as deleted. While the title will no longer appear in search results or in Special:All pages, the page history can still be viewed.
 
=== Citations ===
 
(to check) Using the extension Cite, the wiki supports making proper academic style footnotes. It works by putting your reference directly into your text surrounded by the "ref" tag, e.g. <nowiki><ref>Yaron Koren, p. 3</ref></nowiki>
 
=== Page History / version tracking ===


(to write)


=== Special:RecentChanges ===


=Communication=
[[Special:RecentChanges]]


=== Special:AllPages ===
Special:AllPages gives an alphabetical listing of all pages. It's a kind of index.
[[Special:AllPages]]
=== Redirect ===
Redirects add a bit of the thesaurus to the wiki. Redirects can be used to establish synonyms, and to specify a preferred title or term (the page that actually holds the content). Special pages (like the "index" Special:All pages) and functions like "Backlinks" respect redirects and generally show the preferred title.
<nowiki>
#REDIRECT [[Better title]]
</nowiki>
=== HTML + CSS===
* Simple HTML tags and CSS rules can be used and are allowed by default
* HTML comments work too! <nowiki><!-- this is a comment --></nowiki>
* if you want to publish code on a wiki page with syntax highlighting, you can use a <nowiki><syntaxhighlight></nowiki> element:
<nowiki>
<syntaxhighlight lang="html">
<h1>Hello wiki!</h1>
</syntaxhighlight>
</nowiki>
Which will look like this:
<syntaxhighlight lang="html">
<h1>Hello wiki!</h1>
</syntaxhighlight>
=== nowiki ===
HTML like tag that allows to include stuff that the wiki won't touch
<nowiki><nowiki></nowiki>
=== Categories ===
* <nowiki>[[Category: People]]</nowiki>
* Categories can themselves be tagged with categories to create hierarchies
* Extensions exist to make working with (hierarchical) categories easier
To link to a category page without tagging the current page with that category, add a colon at the start.
* See <nowiki>[[:Category:Fish]]</nowiki> produces [[:Category:Fish]].
=== Transclusion ===
<nowiki>
{{:Name of page}}
</nowiki>
=== Templates ===
Template = Transclusion + Substitution
* Parameters, Named and positional (demo)
* Parser Functions?
* includeonly, ...
To dive into templates, see: https://www.mediawiki.org/wiki/Help:Templates
=== Variables ===
* <nowiki>{{CURRENTPAGE}}</nowiki>
* <nowiki>{{CURRENTTIME}}</nowiki>
* <nowiki>{{CURRENTUSER}}</nowiki>
* <nowiki>{{NUMBEROFPAGES}}</nowiki> ?
http://www.mediawiki.org/wiki/Help:Magic_words#Variables
=== Behavior switches ===
"Switches"
* <nowiki>__NOTOC__</nowiki>
* <nowiki>__NOINDEX__</nowiki>
* <nowiki>__HIDDENCAT__</nowiki> : don't show this category
Switches with parameters:
* DISPLAYTITLE: Set the proper title
* DEFAULTSORT: Tell the wiki how to order the page title
<nowiki>
{{DISPLAYTITLE:cat}}
</nowiki>
<nowiki>
{{DEFAULTSORT:Wales, Jimmy}}
</nowiki>
==Communication==


How do collaborators, editors, proofreaders, coordinators and designers communicate withing this ecosystem ?
How do collaborators, editors, proofreaders, coordinators and designers communicate withing this ecosystem ?
''
 
Say one totally disagrees with what is said in page where she is collaborating.''   
''Say one totally disagrees with what is said in page where she is collaborating.''   


There are several ways to go about it.
There are several ways to go about it.
Talk pages are sometimes used for this.
== Some Key Topics ==
* Navigating: [[Special:RecentChanges]], [[Special:NewFiles]], [[Special:AllPages]], [[Special:RandomPage]]
* [https://www.workingwithmediawiki.com/book/chapter4.html Wikitext] : a "lightweight markup", Headers, etc. (there are also some useful [https://www.workingwithmediawiki.com/book/chapter4.html#toc-Section-31 Behaviour Switches] like <nowiki>__NOTOC__</nowiki>)
* Section editing (good way to avoid edit conflicts)
* [https://www.workingwithmediawiki.com/book/chapter5.html#toc-Section-33 Namespaces]: Main, Category, User, [https://www.workingwithmediawiki.com/book/chapter6.html#toc-Section-37 Talk]
* [https://www.workingwithmediawiki.com/book/chapter5.html#toc-Section-34 Redirects] & Renaming
* Linking: Name normalization, [https://www.workingwithmediawiki.com/book/chapter5.html#toc-Section-35 Subpages]
* Media: [https://www.workingwithmediawiki.com/book/chapter7.html Images & Files], Audio/Video
* Advanced: [https://www.workingwithmediawiki.com/book/chapter4.html#toc-Section-28 Transclusion & Templates], [https://www.workingwithmediawiki.com/book/chapter12.html#toc-Section-71 Widgets]
* Extensions and [[Special:SpecialPages|Special pages]] like [[Special:Version]]
* Come on get [[Special:APISandbox|API!]]
== Resources ==
* https://workingwithmediawiki.com/book/ Yaron Koren's book is a good tutorial that explains in a gentrle narrative way topics like [https://workingwithmediawiki.com/book/chapter4.html syntax] you need to edit wiki pages.

Latest revision as of 16:40, 10 September 2024

For a more detailed page on Wikis, a historical perspective and some of its many possibilities see the Wiki page.

This page is more a how-to guide.

As it is a wiki, feel free to edit it.

Wiki editing

Below you can find a cheatsheet with commonly used wikitext mark up.

But first of all, it's good to know is that there are two editors that you can use to edit your text:

Visual editor

Wikitext editor

cheatsheet

''italics'' 
 
 '''bold''' 
 
 '''''bold and italics''''' 
 
 ==standard header== 
 
 ===next-level header=== (...and so on) 
 
 [[Internal link]] 
 
 [[Internal link|alternate text]] 
 
 [http://example.com text of external link] 
 
 [[Category:Example]] (category tag) 
 
 [[:Category:Example]] (link to category) 
 
 ---- (horizontal line) 
 
 * bulleted item 
 
 # numbered item 
 
 :indentation 
 
 ::double indentation (...and so on) 
 
 ;term : definition 
 
 [[File:Image-name.jpg|thumb|frame|Caption text]]
 
 {{:Transcluded page name}} 
 
 {{Template name}} (call to template) 
 
 #REDIRECT [[Page name]]

editing

How to write on the wiki?

Writing on a wiki is not not very different from writing a blog.

You have a Read and Edit mode.

Edit lets you enter content and make changes to existing content.

While you are editing, you can preview your changes in the Preview window.

Once done editing save the page, otherwise your contribution will be lost.

Title Headings

You can make titles with different hierarchic levels by using "=" as follows: 

=Main Title=

==Sub Title==

===Sub-sub Title===

===Sub-sub-sub Title===

You can place content under each of these section

page creation

How to create a page?

In a wiki the information is organized into pages or articles ( no great distinction between the two). If you want to say something about something for which there isn't a page, you create that page and start writing its content.

To create a page create internal links [[name of new page]] for that page

The other easy way to create is to use the search function with the name of the page you want to create. When searching, you are given the possibility to create that page.

Note: For your work you should use sub pages under your user namespace. [[User:yourusername/mypage]]

  • Red link = previously non-existing page.
  • Blue link = existing page.

Wiki - an existing page

oooooooo - an non-existing page

Links

There are two kinds of links:

  • internal (to another wiki page)
  • external (to anything outside this wiki)

internal links

So, when you want to make a link to a page on this wiki: 

[[name of page]]

For example a link to the Main Page looks like: 

 [[Main Page]]

will result in: Main Page

Note: these links are case sensitive.

external links

You can write external links in different ways:

Just by pasting a URL:

https://xpub.nl/: https://xpub.nl/

Using link text:

[https://xpub.nl/ XPUB's website]: XPUB's website

Or as a "footnote"

[https://xpub.nl/]: [1]

red links

Significantly, wikis allow links to pages that do not (yet) exist. These are called "redlinks" (typically they appear in red to differentiate from "blue" normal links). In this was editors can write with links without knowing (or caring) if a given page exists. Redlinks can form a "potential page" or "todo" articles that when created in the future, will already be linked. Non-existent (redlink) Pages do display backlinks even before they are given any content (though they will not appear in Special:AllPages, they can be seen via Special:WantedPages)

Audio-visuals

uploading images

You probably want not only to write, but also to use images, audio and video on the pages you'll be developing.

Wiki allows the following formats:

Medium Formats
image png, gif, jpg, jpeg, svg
audio ogg, mp3
video ogv, webm, mp4

To upload you can use the picture icon on the menu. It asks you for the file name of the file you are going to upload (they must match) and a caption, if you to say something about that image, video, or audio.

The syntax to insert an image: 

[[File:myimage.png|My caption]]

Captions can be added to images by using a vertical bar (the "pipe"): 

[[File:myimage.jpg|Caption under the image]]

Audio

Download the Widgets extension: https://www.mediawiki.org/wiki/Extension:Widgets

And copy the full content of this page to your wiki, in a page called "Widget:Audio": https://pzwiki.wdka.nl/mediadesign/Widget:Audio

Video files

Using {{#Widget:Video}}

This widget is configured on this page: Widget:Video

You can use it in this way: 

 {{#Widget:Video|webm=http://url.to/your.webm|mp4=http://url.to/your.mp4|style=}}

For example: 

 {{#Widget:Video|mp4=https://pzwiki.wdka.nl/mw-mediadesign/images/a/af/Traffic_lights.mp4|style=height:200px;float:right;}}

Youtube/Vimeo videos

To include, you need:

  • the ID of the video you want to include in you page
  • to write {{youtube|id}} for Youtube or {{vimeo|id}} for vimeo. Where the id is the sequence of numbers and letters that follow ?v= in Youtube videos url, and vimeo.com/ in Vimeo videos)

Example: {{youtube|A1YYv_J2csk}} {{vimeo|68841788}}

will results in:

http://vimeo.com/68841788

Wiki calendar care

Here's a link to how to add information to the calendar and what do you if it disappears.

Help the calendar disappeared

Changing page titles

Pages' titles can be changed by using the function Move in the top right corner in a dropdown menu next to the star.

The Move page permits you to attribute a new name to the current page. Move lets you effectively rename a page. By default, a move shifts content to the new title, and creates a redirect from the old title to the new one; in this way links to the old page will not break and will simply redirect to the correct page. In this way, a move is consistent with the wiki attitude of keeping history visible. 

Move = (Copy and Paste) + (Redirect or Delete)

Deleting pages

Deleting a page is also possible. Note however that a delete is simply a way of marking that page as deleted. While the title will no longer appear in search results or in Special:All pages, the page history can still be viewed.

Citations

(to check) Using the extension Cite, the wiki supports making proper academic style footnotes. It works by putting your reference directly into your text surrounded by the "ref" tag, e.g. <ref>Yaron Koren, p. 3</ref>

Page History / version tracking

(to write)

Special:RecentChanges

Special:RecentChanges

Special:AllPages

Special:AllPages gives an alphabetical listing of all pages. It's a kind of index.

Special:AllPages

Redirect

Redirects add a bit of the thesaurus to the wiki. Redirects can be used to establish synonyms, and to specify a preferred title or term (the page that actually holds the content). Special pages (like the "index" Special:All pages) and functions like "Backlinks" respect redirects and generally show the preferred title.

#REDIRECT [[Better title]]

HTML + CSS

  • Simple HTML tags and CSS rules can be used and are allowed by default
  • HTML comments work too! <!-- this is a comment -->
  • if you want to publish code on a wiki page with syntax highlighting, you can use a <syntaxhighlight> element:

<syntaxhighlight lang="html"> <h1>Hello wiki!</h1> </syntaxhighlight>

Which will look like this: 

<h1>Hello wiki!</h1>

nowiki

HTML like tag that allows to include stuff that the wiki won't touch 

<nowiki>

Categories

  • [[Category: People]]
  • Categories can themselves be tagged with categories to create hierarchies
  • Extensions exist to make working with (hierarchical) categories easier

To link to a category page without tagging the current page with that category, add a colon at the start.

Transclusion

{{:Name of page}}

Templates

Template = Transclusion + Substitution

  • Parameters, Named and positional (demo)
  • Parser Functions?
  • includeonly, ...

To dive into templates, see: https://www.mediawiki.org/wiki/Help:Templates

Variables

  • {{CURRENTPAGE}}
  • {{CURRENTTIME}}
  • {{CURRENTUSER}}
  • {{NUMBEROFPAGES}} ?

http://www.mediawiki.org/wiki/Help:Magic_words#Variables

Behavior switches

"Switches"

  • __NOTOC__
  • __NOINDEX__
  • __HIDDENCAT__ : don't show this category

Switches with parameters:

  • DISPLAYTITLE: Set the proper title
  • DEFAULTSORT: Tell the wiki how to order the page title

{{DISPLAYTITLE:cat}}

{{DEFAULTSORT:Wales, Jimmy}}

Communication

How do collaborators, editors, proofreaders, coordinators and designers communicate withing this ecosystem ?

Say one totally disagrees with what is said in page where she is collaborating.

There are several ways to go about it.

Talk pages are sometimes used for this.

Some Key Topics

Resources

Retrieved from "https://pzwiki.wdka.nl/mw-mediadesign/index.php?title=Wiki_Tutorial&oldid=272160"