Help:Adding a new programming language: Difference between revisions

From Rosetta Code
Content added Content deleted
(list good starter examples)
(→‎Language Page: rewrite for current usage)
Line 21: Line 21:
==Language Page==
==Language Page==


Rosetta code uses the Category namespace for describing programming languages, with a normal page redirecting to it for more convenient links.
If a programming example already exists for the language, creating a language page is extremely simple. Just click on the link to the language, and click "Create this article", on the resulting page. Add whatever information is appropriate, and end the article with the language template.


If a programming example already exists for the language, creating a language page is simple. Just click on the link to the language, and click "Create this article", on the resulting page. Add the following text, replacing ''My Language'' with the name of your programming language:
===Language Template?===


<pre><nowiki>
That's right. Each language page has the language template applied to it. The language template points out that the article describes a programming languages, and offers a link pointing back to any page that points to it. In this way, someone curious about a language can find all of the programming examples that use it.
#REDIRECT [[:Category:My Language]]
</nowiki></pre>


Now click the "Save" button. The resulting page will have a red link on it, because you have not yet created the category. Click on the red link to create the category, and add at least this boilerplate:
The language template also adds the page to the Language category, so that people interested in seeing a complete list of languages at Rosetta Code can go to the Language Category index page to see the list.


<pre><nowiki>
To add the language template to a page, add the text <nowiki>{{Programming Language}}</nowiki> to the end of the page.
Short description of your language.
[[Category:Solutions by Programming Language]]
</nowiki></pre>


Your language description should briefly point out unique features of the language and provide links to external sites for more information or downloads. You can also provide wiki links to other languages or other wiki pages for cross-reference. If you have little to say, please prepend the text <code><nowiki>{{stub}}</nowiki></code> to let us know more information needs to be added.
Click Preview Page, and you can see what your page will look like. Click Save Page, and you'll also see the page added to the Language category.


Now hit "Save" again. Go back to the example page and reload. Check that clicking the header link for your language takes you to the category page you just created, and that the example shows up in a section titled '''Articles in category "My Language"'''.
Cool, huh?


==Conclusion==
==Conclusion==

Revision as of 16:26, 7 November 2007

If you're familiar with the language, adding a new programming language is simple enough.

Programming Example

You should probably start by examining the existing programming tasks, and finding one that you can complete with your language of choice. Good starter examples are Empty Program, Comments, User Output, and those in Category:Control Structures and Category:Basic Data Operations.

Then you need to add a programming example to that task. Find the place in the list of languages already applied where your language would fall, alphabetically. Then enter something like this:

 =={{header|C}}==
 '''Compiler:''' [[GCC]] 4.0.1
 
  int main ( void ) {
       // Some code here
  }

You don't have to use the C programming language, and your code example will probably be different. You need to make sure you create a link to your language of choice, and to your compiler, interpreter, or what-have-you. To create a link, surround the text with double square brackets. For example, GCC would be represented as [[GCC]].

Finally, note the importance of the extra space in front of the code. That creates a dashed box around the code sample, and puts it in a monospace font.

Language Page

Rosetta code uses the Category namespace for describing programming languages, with a normal page redirecting to it for more convenient links.

If a programming example already exists for the language, creating a language page is simple. Just click on the link to the language, and click "Create this article", on the resulting page. Add the following text, replacing My Language with the name of your programming language:

#REDIRECT [[:Category:My Language]]

Now click the "Save" button. The resulting page will have a red link on it, because you have not yet created the category. Click on the red link to create the category, and add at least this boilerplate:

Short description of your language.
[[Category:Solutions by Programming Language]]

Your language description should briefly point out unique features of the language and provide links to external sites for more information or downloads. You can also provide wiki links to other languages or other wiki pages for cross-reference. If you have little to say, please prepend the text {{stub}} to let us know more information needs to be added.

Now hit "Save" again. Go back to the example page and reload. Check that clicking the header link for your language takes you to the category page you just created, and that the example shows up in a section titled Articles in category "My Language".

Conclusion

Thanks for showing an interest in adding information to Rosetta Code. With the help of people like you, Rosetta Code will become a true programmer's resource!