Difference between pages "Linuxintro:About" and "Help:Editing"

From Linuxintro
(Difference between pages)
imported>ThorstenStaerk
 
imported>ThorstenStaerk
(New page: This is a wiki. This means, depending on your priviledges, you can edit articles. You can use a special syntax to format text, include links and so on. = Format text = == Headings == To ...)
 
Line 1: Line 1:
= What is it about =
+
This is a wiki. This means, depending on your priviledges, you can edit articles. You can use a special syntax to format text, include links and so on.
After 8 years of practical Linux, I have some ideas how Linux documentation on the web should be. This is why I started this site. Here is what I think should apply to every tutorial on the web.
 
  
* There are no experts. Being an expert enables you to learn even more from a given text. As an expert, you read something and you find things that really "everyone should know".
+
= Format text =
* Be practical. When I searched for "use camcorders with Linux" in the web, I just wanted to know which application to start to connect my camcorder and transfer the video. One article I found was three pages long, started explaining that with Linux, everything is modular and thus better, then went on to a rant about Microsoft, explained how to compile a Linux 2.2 kernel so firewire works and ended with an explanation that Linux is better than Windows. It just forgot to mention which program to start. Always tell the program to start for a given application.
 
* fetch the reader from where he is. When I was teaching Linux, people were asking how to use <tt>ls</tt> to find the size of a directory. Now you cannot find this out with ls, you need to use du. But as long as you do not know du, you will not look it up. And as soon as you know du, you will not need to look it up, because you know it already. So, the consequence is, when writing a tutorial on <tt>ls</tt>, make a link to du in it, about like this:
 
To find out a directories' size, do not use ''ls'', but [[du]]
 
Also make a link to du into your article on ''directory''. Similar thing: You use ethtool to find out if a network cable is plugged into your network card. "Link detected = Yes" means there is a cable (with link), "Link detected = No" yet does not mean there is no cable. It can also mean the network card is not active. Tell the reader.
 
* Man pages are not enough. Or is there a man page "how_to_install_linux_on_a_usb_disk" and man how_to_use_a_camcorder_with_Linux and man how_to_setup_a_webcam_with_Linux?
 
** Man pages give you a fraud security to know something. Read e.g. [http://linux.die.net/man/1/addr2line addr2line's] man page and tell me why addr2line /bin/bash 200 does not work. You cannot tell from the man page.
 
* Think out of the box. When I write a [[bash scripting tutorial]] I also explain [[wc]], [[grep]] and [[awk]] although these are - in an academic sense - not part of the [[bash]]. However, in practical life you cannot script bash well without knowing about how it interfaces with these tools.
 
* Wikipedia is not enough. Wikipedia says about itself it is not a tutorial.
 
  
= How was it done =
+
== Headings ==
I used plain mediawiki software. I added and removed
+
To make headings:
* [[Mediawiki#FaceBook_like_buttons|added the FaceBook "like" buttons]]
+
{| border=1
* [http://www.mediawiki.org/wiki/Extension:FacebookComments FaceBook Comments Extension].
+
! This markup !! produces
 +
|-
 +
| <nowiki>= Header =</nowiki> ||
 +
= Header =
 +
|-
 +
| <nowiki>== Sub-Header ==</nowiki> ||
 +
== Sub-Header ==
 +
|-
 +
| <nowiki>=== Sub-sub-Header ===</nowiki> ||
 +
== Sub-sub-Header ==
 +
|-
 +
|}
  
I just added
+
== Font Face ==
* [http://www.staerk.de/thorsten/Google_adds Google Ads]
+
To make bold or italic font:
* [https://www.mediawiki.org/wiki/Extension:ConfirmEdit ConfirmEdIt ExTension]
+
{| border=1
 +
! This markup !! produces
 +
|-
 +
| <nowiki>This is ''italic'' and this is '''bold'''.</nowiki> || This is ''italic'' and this is '''bold'''.
 +
|-
 +
|}
  
Due to massive spam I had to disallow registration to this wiki. If you want to register, read on.
+
== Code ==
 +
To make clear text is meant as code or computer in/output just prepend a space at the beginning of the line:
 +
<- here is a space at the beginning of the line.
  
= Want to join us =
+
= Creating links =
You want to write an own article on here? Help improve other articles?
+
To link to another article in this wiki:
Then please write a mail to dev at staerk dot de with the subject "account for linuxintro". Sorry for the inconvenience but there were massive spamming attacks when editing was allowed to everybody.
+
{| border=1
 +
! This markup !! produces
 +
|-
 +
| <nowiki>Have a look at our [[application]] section.</nowiki> || Have a look at our [[applications]] section.
 +
|-
 +
|}
 +
To link to another namespace, e.g. a category:
 +
{| border=1
 +
! This markup !! produces
 +
|-
 +
| <nowiki>Have a look at our [[:Category:Guides]] section.</nowiki> || Have a look at our [[:Category:Guides]] section.
 +
|-
 +
|}
 +
 
 +
= Creating tables =
 +
Make a sortable table. This input:
 +
<pre>
 +
{| class="wikitable sortable" border=1
 +
! col1 !! col2 !! col3
 +
|-
 +
| field1 || field2 || field3
 +
|-
 +
| ZZZ    || AAA    || MMM
 +
|-
 +
|}
 +
</pre>
 +
Produces:
 +
{| class="wikitable sortable" border=1
 +
! col1 !! col2 !! col3
 +
|-
 +
| field1 || field2 || field3
 +
|-
 +
| ZZZ    || AAA    || MMM
 +
|-
 +
|}

Revision as of 07:31, 12 October 2008

This is a wiki. This means, depending on your priviledges, you can edit articles. You can use a special syntax to format text, include links and so on.

Format text

Headings

To make headings:

This markup produces
= Header =

Header

== Sub-Header ==

Sub-Header

=== Sub-sub-Header ===

Sub-sub-Header

Font Face

To make bold or italic font:

This markup produces
This is ''italic'' and this is '''bold'''. This is italic and this is bold.

Code

To make clear text is meant as code or computer in/output just prepend a space at the beginning of the line:

<- here is a space at the beginning of the line.

Creating links

To link to another article in this wiki:

This markup produces
Have a look at our [[application]] section. Have a look at our applications section.

To link to another namespace, e.g. a category:

This markup produces
Have a look at our [[:Category:Guides]] section. Have a look at our Category:Guides section.

Creating tables

Make a sortable table. This input:

{| class="wikitable sortable" border=1
! col1 !! col2 !! col3
|-
| field1 || field2 || field3
|-
| ZZZ    || AAA    || MMM
|-
|}

Produces:

col1 col2 col3
field1 field2 field3
ZZZ AAA MMM