DynPG-Wiki:Help

From DynPG-Wiki

Writing in this wiki is done by using a simple markup language called Wikitext. As this documentation wiki is using the same system (MediaWiki) as the Wikipedia, experienced users should have no problem to get along with this documentation.

But even if you are unfamiliar with using a wiki, this should not keep you from contributing here if you would like to do that, since learning Wikitext is very easy and can be done in no time. Therefore we want to provide a short introduction that will enable you to use almost every functionality of this wiki.

Contents 1 General informtion about navigating in this wiki 2 Creating and editing articles 2.1 Editing an article 2.2 Creating an article 3 Formatting text 3.1 Overview of the Wikitext markup elements 3.2 Allowed HTML tags 3.3 Tables 4 Marking articles as old or stubs 5 Link articles to other languages 6 Categories 7 More information about writing in a wiki

General informtion about navigating in this wiki

A wiki consists of a number of articles. Every article has a title and can be reachd by an URL like http://www.dynpg.org/wiki/index.php/article_name. Examples are the Overview article as well as the Main Page.

Next to articles there are categories. A category is just like a normal article, except that other articles can be associated to it. These articles appear in the form of a list below the actual text. A category can be reached by navigating to the URL http://www.dynpg.org/wiki/index.php/Category:category_name'.

This wiki has the following categories (also listed on the Main Page):

• Category:Introduction
• Category:Installation and update
• Category:Integrating DynPG into a web site
• Category:Modules
• Category:Examples
• Category:Usage of the backend
• Category:Source code documentation

Creating and editing articles

Editing an article

In order to edit an article, you have to be logged in. If you want to edit, follow these steps:

• navigate to the article you would like to edit
• click on the edit tab in the list of tabs above the article text
• edit the wikitext and click on save

Creating an article

In order to create an article, you also have to be logged in. The steps are as follows:

• think about the category the new article belongs to (see above)
• navigate to the page of this category
• click on edit on the page of the category
• search for a suitable positon in the text, where the link to the article should be placed.
• insert the link by writing something like [[My new article]].
• save the changes on the category page. The new category page will be displayed.
• click on the link you created (it should have a red color). You will be redirected to the edit page of this article.
• now write your article and save it

Note: After a certain amount of time has passed, you might be logged out automatically. In order to avoid that, check the "Remember me" box on the login page.

Formatting text

Overview of the Wikitext markup elements

Tip: Some of these markup elements can also be activated by clicking on the corresponding button in the editor.

• Italic:

''italic text''

• Bold:

'''bold Text'''

• Headings:

== Section ==

=== Subsection ===

==== Subsubsection ====

• New paragraph:

blank line in the text

• Indentation:

: at the beginning of a line

the more :, the deeper the indent of the item will be

• Itemized list:

* at the beginning of a line

the more *, the deeper the indent of the item will be

• Numbered list:

# at the beginning of a line

the more #, the deeper the indent of the item will be

• Link to other DynPG wiki article:

[[article_name|link text]]

• Link to a category in the DynPG wiki:

[[:Category:category_name|link text]]

• Link to a website in the WWW:

[http://www.url.de link text]

• Images:

[[Image:filename.ext|frame or thumb or for example 200px|Image signature]]

if you are logged in, you can upload images by clicking on the corresponding link in the toolbox menu

• Files:

[[Media:filename.ext|link text]]

files are uploaded just like pictures

• Horizontal line:

---- in a separate line

• Unformatted text in a box:

<pre>text in a box</pre>

• HTML or PHP source code:

<code>[html, N] Code </code> --- HTML-Code, no line numbers

<code>[php, Y, 3] Code </code> --- PHP-Code, line numbers beginning at 3

• Embedding flash videos:

<flvplayertwo width="320" height="240" autoplay="false">URL to the flv file</flvplayertwo>

Note: After you have logged in, you can upload flash videos to this wiki. By accessing the article page of the uploaded file (e.g. http://www.dynpg.org/wiki/index.php/Image:Flowplayer.flv) you can find out the correct URL (e.g. http://www.dynpg.org/wiki/images/a/a4/Flowplayer.flv) of the flv file.

Allowed HTML tags

Among others: <blockquote>, <br>, <center>, <dd>, <dl>, <dt>, <div>, <em>, <i>, <li>, <ol>, <table>, <td>, <th>, <tr>, <u>, <ul>, <!-- -->

Tables

• Example one

{| border=1
|+ Important files of DynPG
|- bgcolor=grey
! File name !! Directory !! Function
|-
| align=right | getcontent.php || dynpg/ || Pivotal file of DynPG
|-
| align=right | _articles.php || dynpg/ || Article view in the backend
|-
| align=right | articles.tpl || dynpg/tpl/MyCMS/default || Frontend template for article list view
|}

looks like:

Important files of DynPG

File name	Directory	Function
getcontent.php	dynpg/	Pivotal file of DynPG
_articles.php	dynpg/	Article view in the backend
articles.tpl	dynpg/tpl/MyCMS/default	Frontend template for article list view

• Example 2

{| class="dynpgwikitable"
|+ Important files of DynPG
|-
! File name !! Directory !! Function
|-
| align=right | getcontent.php || dynpg/ || Pivotal file of DynPG
|-
| align=right | _articles.php || dynpg/ || Article view in the backend
|-
| align=right | articles.tpl || dynpg/tpl/MyCMS/default || Frontend template for article list view
|}

looks like:

Important files of DynPG

File name	Directory	Function
getcontent.php	dynpg/	Pivotal file of DynPG
_articles.php	dynpg/	Article view in the backend
articles.tpl	dynpg/tpl/MyCMS/default	FFrontend template for article list view

Marking articles as old or stubs

To mark an article as old, put {{old}} at the beginning of the article text. A corresponding message will be shown on the page of that article and it will be displayed on the page of the category Out of date. Similar to this, putting {{stub}} at the beginning of an article will mark it as too short and it will be displayed on the page of the category Short articles.

Link articles to other languages

An article should be linked to it's counterparts in the other language wikis. Add the [[de:Name_of_the_german_article]] element in order to link the article to it's German equivalent. The link will appear on the left side in the navigation menu.

Categories

To add the article that is currently being edited to a category, add the following Wikitext (preferably at the beginning or end of the article) to it:

[[Category:category name]]

Note: This code can easily be mixed up with adding a link to another article.

More information about writing in a wiki

• Overview page for article writers in the Meta-Wiki
• WikiMedia Reference Card for Wikitext elements (very helpful for beginners)