ErrorDatabase:Writing

From ErrorDatabase

This article describes the guidelines and standards for writing for ErrorDatabase. If you are not familiar with MediaWiki's features then you should read the ErrorDatabase Crash Course.

[edit] General

Pages should be organized into sections. The topmost sections of any page should pertain to the programming language corresponding to the error message. The subsections of the language section can be organized in any way, however this template is provided for references: ErrorDatabase:Template. Anytime you create or update a page, make sure that it is placed in the appropriate categories. If you begin work on a page, but it is not complete you should add it to the Drafts category.

[edit] Error Messages

There should be a section title 'Messages' in which you innumerate all of the error messages (often times just one) relating to your page. Error messages should appear exactly as they do when generated with the exception of any irrelevant information being removed. This includes file paths and line numbers, unless the error message is specific to a particular application in which case you should leave them. For example: Notice: undefined offset: 2 in /srv/www/public_html/index.php on line 32 would become Notice: undefined offset: <offset> in <file> on line #.

[edit] Code Examples

Using code examples to illustrate the conditions in which the error occurs as well as how to avoid it can be very helpful. You are encouraged to use code examples whenever relevant. However, we ask that you test the code to ensure it behaves as described. Also, please make sure to use <source lang="some language"></source> tags when posting code.