How to use the SRL Wiki

From SRL Wiki

Jump to: navigation, search

Contents

How to edit Wiki articles

The option to edit Wiki pages is open to all users registered at the SRL Community. To edit a page, you simply have to click on the edit tab, located at the top of the screen, to the right of the discussion tab.

Seeing as the Wiki is free-to-use, you can commit any changes to the Wiki that you wish, but DO NOT abuse the wiki, as it will be dealt with severely.

Only commit changes after they have been previewed, and for any of the reasons below:

  • You have discovered an error on an existing article.
  • You are creating a new article.
  • You are updating or adding to an existing article.
If you have written an article but it is from a tutorial already existing on SRL, ie you copied it from SRL and put it in Wiki format, please post the original author in the discussion section, not on the main page.


When writing/updating a Wiki article please use "Preview" until the article is how you want it to be, otherwise the Recent Changes page fills up with the same topic being edited many times for minor issues. Thank you!


When putting up a file for download that is not on SRL, or another trusted site, please show proof that the file is safe or have it peer checked, otherwise DO NOT put up the link. Thank you!

How to create new Wiki pages

This may seem difficult as there is no icon for it, but simply put, in your URL bar you can just type what you want your page to be: 

http://www.villavu.com/wiki/index.php/WHATEVER_YOU_WANT_TO_CALL_YOUR_PAGE

This will link you to a page with the following options when you press enter; 

There is currently no text in this page. 
You can search for this page title in other pages, search the related logs, or edit this page.

If you click the "edit this page" option, then you can make the page you require by typing in your information!

You can also create pages by using the [[This can be a new page]] idea. When you read an article and you can see Red text which is hyperlinked to nowhere, it means you can create that page.

Formatting Wiki articles

There are a few things you can do to make your Wiki article more aesthetically pleasing. By using bold, italic, code boxes and headers, you can separate your article up into sections so that it is not one, big block of text.

Linking Pages to a Category

When you are writing a tutorial which fits in a category you have found, you can put your page in this category. This is a simple thing to do, all you have to do is write [[Category: whatever your Category is called]].

Using Pascal Code Formatting

To get the Pascal code looking like it does in scar, you must use < source lang="pascal"></source>, without the space between the "< s".

This means that your code which looks nice in SCAR does not come out like this (I have used < pre></pre> tags to contain the code, but this is pretty much the same as if you do not use any formatting); 

procedure SetupScript;
begin
  SmartSetupEx(SMARTWorld, false, true);
  SetTargetDC(SmartGetDC);
  while not SmartReady do Wait(2000);
  SRLId := YourSRLId;
  SRLPassword:= YourSRLPassword;
  SetupSRL;
  ScriptID:= '687';
  Signature;
  DeclarePlayers;
  LoadDTMs; //Load DTMs is here.
  LoginPlayer;
end;

but comes out neat and tidy like this; 

procedure SetupScript;
begin
  SmartSetupEx(SMARTWorld, false, true);
  SetTargetDC(SmartGetDC);
  while not SmartReady do Wait(2000);
  SRLId := YourSRLId;
  SRLPassword:= YourSRLPassword;
  SetupSRL;
  ScriptID:= '687';
  Signature;
  DeclarePlayers;
  LoadDTMs; //Load DTMs is here.
  LoginPlayer;
end;

For a list of all supported code's in our Wiki, please navigate to this page.

Bold/Italics

This is also straight forward. You can choose to use the "B" and "I" button found in the option toolbar at the top of the edit box, or you can use these methods:

  • Bolding
You must use 3 apostrophes ( ' ) to achieve the bolding effect;
'''This Makes my text Bold'''
This Makes my text Bold
  • Italics
You must use 2 apostrophes ( ' ) to achieve the italics effect; (Note: do not confuse this with the quotation mark)
''This Makes my text Italic''
This Makes my text Italic
  • Bold and Italics
You must use 5 apostrophes ( ' ) to achieve the bolding and italics effect;
'''''This Makes my text Italic and Bold'''''
This Makes my text Italic and Bold

Embedding Images

Wizzup? has allowed external images to be embedded, which means that you just have to put the URL of the image in your text, and the Wiki page will display the source.

Please keep a few things in mind when uploading images;

  • No offensive or grotesque material
  • Please do not upload very large images, keep them a reasonable size
  • Use a reliable image host. I personally recommend TinyPic
  • Please keep all pictures relevant
  • Make sure the picture is good quality. It is no good having a great article and relevant picture if no one can see it!

A Few Small Rules

  • DO NOT abuse your freedom on the Wiki by editing profiles/articles with childish rubbish.
  • DO NOT delete a whole article and start again. Use what is already there and improve it.
  • DO be active on the Wiki. Make new articles and improve existing ones.
  • DO help out around the Wiki.
  • DO edit out inappropriate material if you ever find it.
Retrieved from "http://villavu.com/wiki/How_to_use_the_SRL_Wiki"
Personal tools