Difference between revisions of "Help:Contents"

From Hackerspace ACKspace
Jump to: navigation, search
(updated help page)
m (fixed TOC transclusion)
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
Creating a wiki entry is somewhat different from creating regular HTML pages.  Here are some notes on how to create a wiki page without having it look messy.  If you manage to handle some of them, you can [[Getting started|get started]] on this wiki.
 
Creating a wiki entry is somewhat different from creating regular HTML pages.  Here are some notes on how to create a wiki page without having it look messy.  If you manage to handle some of them, you can [[Getting started|get started]] on this wiki.
  
__TOC__
+
<noinclude>__TOC__</noinclude>
 
=== paragraphs ===
 
=== paragraphs ===
 
Newlines are for edit maintainability; when you enter text, separated by a newline, mediawiki will make it continuous (like a book), unless you create a new paragraph by typing two newlines.
 
Newlines are for edit maintainability; when you enter text, separated by a newline, mediawiki will make it continuous (like a book), unless you create a new paragraph by typing two newlines.
Line 94: Line 94:
 
| line n column n
 
| line n column n
 
|}
 
|}
 +
 +
=== widgets ===
 +
There are a couple of widgets on this wiki which can display some advanced stuff like the [[Widget:SpaceAPI|spacestate]], [[Widget:ImageLoader|image loader]], [[Widget:YouTube|youtube video's]], local [[Widget:Html5media|html5 video's]] and a [[Widget:Calendar|calendar]]
  
 
=== inline queries ===
 
=== inline queries ===
Line 104: Line 107:
 
|format=list
 
|format=list
 
|mainlabel=-
 
|mainlabel=-
|outro=&nbsp;(secretaris)
 
 
|order=ascending
 
|order=ascending
 
|offset=0
 
|offset=0
Line 114: Line 116:
 
|offset=0
 
|offset=0
 
}}
 
}}
 
  
 
=== see also ===
 
=== see also ===
 
[https://www.mediawiki.org/wiki/Help:Formatting mediawiki.org/wiki/Help:Formatting]
 
[https://www.mediawiki.org/wiki/Help:Formatting mediawiki.org/wiki/Help:Formatting]

Latest revision as of 16:34, 22 April 2023

synopsis

Creating a wiki entry is somewhat different from creating regular HTML pages. Here are some notes on how to create a wiki page without having it look messy. If you manage to handle some of them, you can get started on this wiki.

paragraphs

Newlines are for edit maintainability; when you enter text, separated by a newline, mediawiki will make it continuous (like a book), unless you create a new paragraph by typing two newlines.

Don't use HTML line breaks, it's not maintenance friendly. Small phrases on a separate line are either (bullet) lists or table items.

lists

You can make a list of it by prefixing an asterisk (*), colon (:) or hash/pound (#), so it will look like this:

  • these are
  • separate entries

or this:

these lines
have no
list decoration
  1. first numbered item, line prefixed with '#'
    1. first subitem, prefixed with '##'
    2. second subitem, prefixed with '##'
  2. second item, again prefixed with '#'
    • first subitem, line prefixed with '#*'

style

You can accentuate text by using single quotes. One quote just works as 'expected', but using multiple single quotes around a text part, it will make it italic, bold or underlined.

  • ''two quotes'' makes the text italic
  • '''three quotes''' makes the text bold
  • '''''five quotes''''' makes the text bold-italic

monospace or preformat

If you put a space before
each line of text,
it will preformat the text
ideal for code or configuration settings
note that text formatting does work
You can also use
<pre>tags</pre> but you will lose '''text formatting'''

no format

To make sure some inline text doesn't get wikified, you can use <nowiki>tags</nowiki>

templates

There are several templates to help you (with markup, hinting and linking) They are called by placing them in two curly-brackets. This is a list of some of the templates:

  • {{!}}: Draws a pipe symbol: '|'. It is a special wiki character which you sometimes cannot use directly, for example, in tables or template calls where the pipe symbol is a field separator.
  • {{B|your text}}: Draws a button shape with your text in it.
  • {{K|$}}: Draws a keyboard key shape with '$' in it.
  • {{Hint to add yourself}}: adds a hint box how to add yourself to a (bullet or numbered) list (typically used for events/workshops)
  • {{InfoBox}}: Creates an info box using some generic variables, converting it into html. See: [Template:InfoBox]
  • {{Refresh}}: adds a 'refresh table' button which forces a table generated by a query to be updated by purging the page.
  • {{~|variable name}}: creates a logic inverse on the variable name

tables

Mediawiki tried to make tables simpler than the HTML tables, but the syntax still can be quite daunting. Here is a sample

{| class="wikitable"
|+ Table title
! Header 1
! Header 2
! ...
! Header n
|-
| line 1 column 1
| line 1 column 2
| line 1 ...
| line 1 column n
|-
| ...
|-
| line n column 1
| line n column 2
| line n ...
| line n column n
|}
Table title
Header 1 Header 2 ... Header n
line 1 column 1 line 1 column 2 line 1 ... line 1 column n
...
line n column 1 line n column 2 line n ... line n column n

widgets

There are a couple of widgets on this wiki which can display some advanced stuff like the spacestate, image loader, youtube video's, local html5 video's and a calendar

inline queries

There are some magic variables, for example:

  • You can show ACKspace's telephone number variable [[Phone::+31-45-71 12345]], which is defined on Hackerspace ACKspace:Communication using
    {{#show: Hackerspace_ACKspace:Communication | ?Phone }}
    Like this: +31-45-71-12345
  • The same goes for variables on a protected page, like Become a participant's IBAN: NL16ABNA0563941006
  • You can also list pages that contain a certain variable, like:
{{#ask:[[BoardRole::Secretary]]
|?=
|format=list
|mainlabel=-
|order=ascending
|offset=0
}}

Will give back: Stuiterveer

see also

mediawiki.org/wiki/Help:Formatting