Erlang Central

How to write HowTo's

Revision as of 16:24, 24 August 2006 by EnzianH (Talk | contribs)

Contents

Author

Ludvig Johansson <ludvig@erlang-consulting.com>

Introduction

The best way to start creating a new How To is to look at the source of all the others howto's. (Hopefully someone will give a good explanation on how to create a new one.)

Creating A New Page

A simple way to create a new Wiki page is to edit a URL to the title of the new page.

For instance, for a new page called 'Grokking OTP Principles' you can simply browse to a new URL that looks like this:

http://wiki.trapexit.org/index.php/Grokking_OTP_Principles

Adding New Article To HowTo Category

At the moment the only core thing for creating a new howto is how to add the new article in to the HowTo category.

This is done by adding the line

[[Category:HowTo]]

at the bottom of the howto.

This will then automatically add the article to the category.

Embedding Erlang Code

Erlang code can be embedded in pages using the

<code></code> tags.

The code tag can take a 'caption' attribute which will cause a caption to be displayed for the snippet. It is a good idea to use the code tags rather than try and format code samples yourself since future extensions to the Wiki will include syntax highlighting for appropriately marked up code.

Example

<code caption="Code Snippet 1">

loop() ->
  loop().

</code>

Becomes:


loop() ->
  loop().