EnGardeWiki:WikiContributions
From EnGardeWiki
|
Contents |
Introduction
The EnGarde Secure Linux Wiki needs your help! The Wiki will only thrive if it receives a steady stream of edits and contributions. We encourage you to sign up, jump in, and edit any Wiki entries you think need improvement. This page will show you how.
Determining Topics
You may be asking yourself, "What should I write about?" Well, there is no easy answer to that question. There is always room for Tips, HOWTOs, or Definitions. An even better idea is to check out the Suggested Pages and see what other's need. This works on the principle, see a need, fill a need. If someone wants to know how to accomplish something, and you know how to do it, write a wiki entry and point them in that direction.
Anything related to EnGarde Secure Linux is welcome. If you are still unsure what to write about or where something goes, contact one of the Developers and they will point in the right direction.
Namespace
Make sure that you add the article to the proper namespace. This means that if you are adding an article that you are titling Changing the SSHD Port. That is most likely short and to the point, which would make it a Tips. It would therefore go in the Tips namespace. To do this, make the created article title Tips:Changing the SSHD Port. This will automatically add it to the Tips namespace. If you are doing something more in depth that may be considered a HOWTO like Setting Up A Subversion Repository, then you would title the article, HOWTO:Setting Up A Subversion Repository so it gets added to the HOWTO namespace.
Namespace Index
Each of the namespaces have an index page that has a list of the articles provided within that namespace. They are located as follows:
Add your article to the appropriate Index once it has been completed so it doesn't end up as an orphan.
Creating Wiki Entries
We're glad that you would like to take the time to give back to the community and allow others access to your knowledge. We just want to make sure that you're going to be laying out in the information in a manner that everyone can understand. By following the guidelines below, we can keep the Wiki useful, organized, searchable, and full of information for the curious EnGarde Secure Linux user.
Titling Entries
Now that you have decided to create an entry in the Wiki, make sure you select a title that is useful but not too long. Remember, the title of the article is the URL as well. Use your best discretion when creating the title.
Bad Title:
Changing the port SSH is on for security
The URL will end up looking something along the lines of:
http://wiki.engardelinux.org/index.php/Changing_the_port_SSH_is_on_for_security
Better Title:
Changing the SSH Default Port
Then the URL is slightly more readable and search friendly:
http://wiki.engardelinux.org/index.php/Changing_the_SSH_Default_Port
Article Format
There are a few categories of articles that can be added to the Wiki.
Creating a HOWTO
This is where the majority of entries made into the Wiki are going to fall into. Weather you are creating an applcation specific HOWTO or a general information HOWTO, the dynamic of the document should still be along the same lines.
All HOWTOs should reside in the HOWTO namespace. There are instructions on how to accomplish this at the beginning of the document. The short version is that the article title should have a HOWTO: in front of it. For example, a HOWTO explaining HOWTO create an article should be titled: HOWTO:Creating_A_Wiki_Article
After creating the article, be sure you add it to the proper index page in the proper category. The index page for the HOWTOs is located at Index:HOWTO.
Creating a Tip
Tips are slightly shorter than HOWTOs. They are more of a quick and dirty version of how to accomplish a specific task.
All tips should reside in the Tips namespace. There are instructions on how to accomplish this at the beginning of the document. The short version is that the article title should have a Tips: in front of it. For example, a tip explaining how to correct a typo in a wiki article should be titled: Tips:Correcting_A_Typo
After creating the article, be sure you add it to the proper index page in the proper category. The index page for the Tips is located at Index:Tips.
Creating a Definition
Definitons are descriptions of terms or jargon related to EnGarde Secure Linux or the EnGarde Secure Linux Wiki.
All [[Index:Definitions|Definitions] should reside in the Definitions namespace. There are instructions on how to accomplish this at the beginning of the document. The short version is that the article title should have a Definitions: in front of it. For example, a definition explaining what a wiki typo is in a wiki article should be titled: Definitions:Wiki_Typo
After creating the article, be sure you add it to the proper index page in the proper category. The index page for the Definitions is located at Index:Definitions.
Adding Categories
To put the article in a category, add the following text to the bottom of the article:
<includeonly>[[Category:CategoryName]]</includeonly>
When choosing a category, check the list of categories that have already been created to see if you article fits into one of them. If it does and still requires another category that isn't in existance, then feel free to add it. For instance, if you write an article on extending the use of squid, and you put the article in the squid category. You may have the need to create another category for the program that you are using to extend squid's functionality.
Formatting
Currently there are a few types of templates that can be used in the layout and formatting of the articles. For more information on wiki markup and general editing markup, see the Help:Editing page.
Notes
To add a note to your wiki article, ensure that you use the proper wiki formatting for box notes.
{{Box_Note|This here is my note. It can be as long as I want it to be and even be in multi-line format.
Just remember to close it when you are done.}}
The note itself will look like this:
Code
The goes for code as it does for notes. The only difference is in the color of the box when the proper template is used.
{{Box_Code| # newrole -r sysadm_r
Password:
# audit2allow < selinux_messages}}
The code box itself will look like this:
| Code: |
# newrole -r sysadm_r
Password: # audit2allow < selinux_messages |
Ensure that you use the spaces so the text is put into the preformatted box inside the code box.
Preventing Wikification
Everything between <nowiki> and </nowiki> will not be wikified.
There are other ways. The first is to use the <pre> tag. It works similarly to the <nowiki> tag, except that the contents of the tag are put into a box. It also tends to look better than <nowiki> when spanning over multiple lines.
The second way is to add a space at the beginning of the line. It works just like the <nowiki> tag, except that some basic formatting is still available and the contents of the tag are put in a box. For example, you can still
link to articles
Be careful, it doesn't work very well in boxes.
Combining <nowiki> and a leading space works, but avoid doing it. It is generally better to use the <pre> tag.
Using HTML
There is rarely a case in which actual HTML should be used inside of a wiki. Formatting is what the wiki markup language is used for and formatting is what the wiki engine was designed to run for. Almost anything that can be done in HTML, can be done using the wiki engine. For more detailed help, read Help:Editing for basic help and Help:Tables for creating tables.
Tracking Changes
There is no need to track changes when creating wiki articles. The wiki automatically tracks history and changes for each page. Just ensure that you enter what changes you made to the page in the Summary box at the bottom of the edit page. Be short and to the point when entering your summary.
