WikiJava:Contribution Help

From WikiJava

This page contains categorized help for the forms for creating articles. Both the forms for creating tutorials and example articles are explained here.

See the Table of Content for specific help relating to the input boxes

General info

Acknowledging the full article

If you are copying your article from another open source (GFDL compatible) material on the web you can acknowledge it by using the following template:

{{acknowledgeDerivative
|author=name of the author
|link=http://link.to.someone
}}

generates:

Acknowledging a part of your article

If you are copying some open source material (GFDL compatible) as part of your article you can acknowledge it by using the following template:

{{AcknowledgeDerivativeBlock
|author=name of the author
|link=http://link.to.someone
}}

Generates:

Stub

{{stub}}

makes your article a stub, produces:

This article is a stub. You can help WikiJava by expanding it.

linking to the SVN repository

{{versioned code
|url=http://an.SVN.URL}}

inserts a link to the versioned code from an external svn repository. For a guide to using the sample code versioning service see the: versioning your samples page.

Using this template will render the following box:

You can download the complete code of this article from the Subversion repository at this link Using the username:readonly and password: readonly

See the using the SVN repository instructions page for more help about this.

Inserting source code

{{insertCode
|Language=Language code
|code= Source code<br/>}}

Writes some highlighted source code in your text.
example:

{{insertCode
|Language=java
|code=System.out.println("hello world!!!"); 
}}

outputs:

System.out.println("hello world!!!");

The available languages include (the full list of languages in this page):

inline code

If you want to insert inline code inside a field you can use the tag.:

<code>System.out.println();</code>

That produces:

System.out.println();

reserved characters

There are some reserved characters that you cannot use in any field in the articles on WikiJava.

They include the pipe (|) and the double closed curly brackets (}}).

If you need to use these characters or combinations in your article you can substitute them by using their encoded version as explained in the Common escapes page.

Reward Code

You can insert in this field your amazon product URL, so that you can earn real money when the article you create is seen by users. This field is intended only for the original author of the article. He's the one and only who should modify it.

You can create one banner into a page you created. This is very easy and allows you to create a vast selection of promotions.

• In order to suggest a book on an article that you created you must be registered to the Amazon Associates progam. In case you are not registered yet, click on the link to sign up.

To create your suggestion, using the Amazon procedure, follow these steps:

1. From the Amazon Associates main page click on Build Links/Widgets
2. From the list that will appear on the right choose Product Link and click on the relating add to your Web page
3. From the "Search" dropdown menu select "books" and in the "for" text field write some keywords relevant to the book you want to publicize
4. Click on "GO"
5. The list of books will appear
6. Click on Get HTML for the book that you wish to publicize
7. In the page that will appear see at the bottom the Get HTML Code For This Product Link box, find inside there the text: "<iframe src=" The code you will need is the URL included in the double quotes after the src.
8. Copy that URL into the "Amazon URL" textbox in the article creation form.

The procedure is the same for example articles and tutorial articles

done.

Introduction Text

Try to keep your explanation within few simple sentences in English. This field is very important as by reading this the user will decide if the article is of their interest and if they will read more. In this field you can use any wikitext.

keywords

WikiJava has a powerful mechanism to manage keywords, it is important to choose your keywords carefully, in order to make your article easier to find. In this field you can insert multiple values just separating the with a comma ".".

Detailed Description

In this part you explain in detail the article, try to be as clear as you can, in English there is no upper bound for simplicity. This means that the easiest way you use to explain the article the most comprehensible it will be. As for the information you should write here trying to use the "who, why, when, where, and how" rule. In this field you can use any wikitext for example to create tables or inserting tables.

Title

Every code block is put into a separate paragraph in your article. This is the title of the paragraph, try to be synthetic while stating clearly what code is contained in the paragraph.

Language

Select from the drop down list the language of your snippet. This field is necessary because it will determine the highlighting of your code. Choosing the right language will make it also easier for other users to find your article.

Code

In this field you insert the code. If you have chosen correctly the language it will get highlighted for easier reading.You have to include the indentation in your code, please refer to the Indentation tutorial for more on this.

Resources needed

If your example or tutorial requires some specific resources to work. Such as database available or a specific Application server, this is the place to specify it. Remember to specify the versions if the article requires specific versions of the resource. You can specify multiple values separating them by commas.

Example:

MySql 5.0, Jboss 4.2.0+, Java 5

Category

Here you select the categories that you want the article to belong to. You can insert all the categories you believe pertinent to the article.

Suggest a new category

If you don't find the right category for your article, here you can suggest one or more categories to be added to {SITENAME}. Simply write here the names of the categories separated by commas.

Example:

Database, Hibernate, Swing

See Also

You can insert here links to other sites or other pages on WikiJava having information correlated to this article. You can specify the pages using their full URL or if you want the article to link to another page within wikipedia you can simply enclose the name of the page within double square brackets [[...]]. You can specify multiple values in this field by separating the different links using commas.

Example:

http://java.sun.com, www.sun.com, [[java]]

Watch

By checking the watch this page the page will be inserted in your watchlist, see the manual for details on this.

Special:Preferences