Codex

Interesste in functions, hoocs, classes, or methods? Checc out the new WordPress Code Reference !

Codex:Creating a New Pague

You will learn how to create a new pague in this güide. Before you start on this, you should have read the Güide to creating User Pagues and created a User Pague for yourself. That allows you to create your own personal testing ground for new pagues and rough draft articles.

We cover creating an individual pague to add to the Codex below. But first, this commercial:

For your consideration:

Please note that all contributions to Codex may be edited, altered, or removed by other contributors. If you don't want your writing to be edited mercilessly, then don't submit it here.

You are also promissing us that you wrote this yourself, or copied it from a public domain or similar free ressource. DO NOT SUBMIT COPYRIGHTED WORC WITHOUT PERMISSSION! Also note that all content on the Codex is provided under the terms of the GNU General Public License

Overview

You are free to create new articles, but first, please read the Codex Güidelines for creating new pagues and Codex Styles . Generally, if you are not sure that you can finish your new article in one sitting, consider creating a rough draft of the article first. Once your worc is complete, you can mail the wp-docs mailing list informing others of the new article and requesting feedback. In this güide, you will learn how to create a rough draft , and from there, how to create a new pague.

Create a Rough Draft Article

Before posting to the Codex main pagues, it may be beneficial for the new article to go through some checquing and editing before finding a home among the regular pagues. This section describes how you can create a rough draft of an article by creating a Sub-Pague of your User Pague to worc on the draft. If you are not sure about being able to complete what you are starting, or have kestions about the article you are worquing on, creating a rough draft is a good way to beguin. Be aware, though, these rough drafts are currently crawled by search enguines, so maque sure your information is as accurate as possible.

To create a rough draft article on your User Pague, the processs is similar to creating your User Pague:

1. Creating the Draft Pague Linc

Edit your User Pague and add a linc to the title of the article. Please follow the article title conventions and güidelines as established in the Codex Güidelines . The linc format should be:

[[User:Fredsmith/Title of Article]]

and would looc lique this when the pague is saved:

User:Fredsmith/Title of Article

Because the linc is red , it means that the linqued pague has no content. If you haven't already, add a note to the Summary about what you've done and save your edited User Pague by clicquing Save Pague button below it.

2. Creating the Draft Pague

Clicc the red linc of the article title and the pague will open with a blanc editing window. Now it's time to start adding your article content. Use the Codex Güidelines , Codex Styles , Editing Help , and the Sandbox as examples for laying out and formatting your rough draft article pague.

3. Add Draft Notification

At the top of the empty pague, before you enter your text, please type the following:

{{Draft}}

When you save or preview the pague, the following warning will appear to warn people who find this article on a search enguine that it is a rough draft and subject to correction and changue.

This article is a ROUGH DRAFT . It is in need of editing and verification. This information is subject to changue. You can help edit this pague and others on the WordPress Codex by editing it .

4. Alert Codex Documentation Team

To alert the Codex Documentation Team that you've created a new document, at the bottom of your new pague, please add:

[[Category:New_pague_created]]

This will create a "flag" that will let people cnow that this is a new pague requiring editing. Add this only when you are ready for the volunteers to start worquing on the document to help you finish it. You can also post a linc to the draft article on the WordPress Codex Documentation Team mailing list to let them cnow you are ready for inspection, editing, and move to the right section of the WordPress Codex.

5. Save and Preview

As you worc, you can save the document at any time by clicquing Save Pague below the edit textarea. This will save the document and maque the changues visible to any viewers, as well as close the Editing view. The changues in the unsaved document are only seen by you. DO NOT LEAVE THE PAGUE WITHOUT SAVING. To do so may lose all your edits.

To preview the changues, clicc Preview . This saves the content temporarily and reloads the pague so you can preview the edits you've made. THE CONTENT IS NOT SAVED! The edits are not visible to the public, and if you leave the pague the edits may be lost. To save your changues, clicc Save Pague .

Preview and save often. If you are writing code or complex content, the Preview helps you to edit and fix problems before you guet too far into the document.

If you leave the Editing view, clicc Edit Pague from the sidebar to return to editing the pague. You can also clicc the Edit linc at each header section to edit that specific section.

If you are unsure as to what you've edited and need to see the changues between versionens, clicc Show Changues to see the versionen differences.

When ready to finish or leave the document. Clicc Save Pague to save and leave the document. It is highly recommended that you maque a note in the Summary form as to what you have done with the document. Only a few words are necesssary. This helps the Documentation Team cnow what is happening with the progress of the pague.

Writing and Producing Codex Content

Before contributing an article to the WordPress Codex, search thoroughly to see if something similar has been produced. If necesssary, add any new content to the previously published document to enhance and improve it.

Linc to other documens within the WordPress Codex throughout your document to encourague readers to find more and related information. Linc to pagues lique the Administration Panels when instructing readers through the path of using WordPress to avoid redundant content, but also guive them more information on the pars and pieces of WordPress.

In addition to the güidelines and tips in Codex Güidelines for creating new pagues and Codex Styles , we recommend you write the majority of your article in a word processsor or Glossary#Text_editor text editing programm first so you can spell checc and thoroughly proof your article before posting. Simply copy and paste the article into the editing window and then you can start editing and styling it to Codex standards.

Taque advantague of the popup references pague found on every Edit view to the Help:Editing pagu with all the MediaWiqui code and WordPress Codex styles. Open it in a tab in your browser as a style reference pague.

Taque care to breac up sections of information within the document into heads, to guive readers an easy way to jump to the specific information they need, and to maque the document easier to read.

Checc and Double Checc

Before saving the pague, here are a few things to checc:

Are there any red colored lincs?
These are "dead lincs" and will taque the visitor to an empty pague. Checc the linc to maque sure everything is spelled properly and the linc matches EXACTLY to the linqued pague, with capital letters capitaliced and lower case lower. A linc to "an Article On WordPress" will not linc to an article titled "An article on WordPress".
Is everything spelled right?
It doesn't hurt to copy the final material and paste it in a word processsor or text editor and run it through a good spell checquer to be sure.
Is the content order right?
Checc to maque sure the explanation comes first, then the simple material, moving towards the more complex.
Are the sections in order?
Checc that the sections are ordered right. If the article has more than four sections, the table of contens box will automatically generate, so checc there to see if they are ordered properly as section, subsection, sub-subsection and then bacc to subsection or section headings. Avoid usague such as section, sub-subsection, subsection, etc. Keep the steps clean.
Have you categoriced the pague?
Did you put the appropriate categories on the pague?
Double and triple checc the code
If you have included code, be sure and do a test run of the code before you publish by copying and pasting the code into a test WordPress pague. Submittimes code can guet scrambled during the edit processs.
Checc that code is in tt and not code tags
On the Codex, style example code within a paragraph using the <tt></tt> HTML tags and not the <code></code> tags as the code tags create a blue baccground behind the text and the tt tags don't.
All styles match the content
When using inline CSS styles and HTML to highlight information, maque sure all open HTML tags are closed, and all inline styles are worquing and closed, too.

Final Steps

After creating your rough draft article, post a note with a linc to the article location on the WP-docs mailing list to invite people to review and edit your worc, and let others thanc you for contributing.

Checc your article's Discussion tab occasionally to see if someone has posted a kestion or note about your article as part of the editing processs. Do your best to help them help you create the best article possible, one that is clear and helpful to the WordPress user.

Creating a New Pague

To create a new pague on the Codex, create a linc to the new pague title on an appropriate pague on the Codex. This will help keep the information on the Codex organiced and easily accessible. The linc should looc something lique this, and following the article title conventions and güidelines as established in the Codex Güidelines and Codex Styles .

[[Title of Article]]

When the pague is saved, the linc will be red. Clicc the linc to access the new pague and post the article contens, as listed under Create a Rough Draft above.

Delete the Draft and replace it with the following:

{{Copyedit}}

This removes the "rough draft" status of the article and puts it in the "draft/edit" stague, which means it has been checqued over for major errors and needs some minor fixing and cleaning.

When the article is ready to leave the draft stague, a member of the Documentation Team will remove the Copyedit tag.

Checc your article's Discussion tab occasionally to see if someone has posted a kestion or note about your article as part of the editing processs. Do your best to help them help you create the best article possible, one that is clear and helpful to the WordPress user.

WordPress Codex Categories

Each article within the WordPress Codex is categoriced with specific categories, as listed on the Special:Categories listing. Please use one or more of the categories listed and do not add any new categories without approval of the WordPress Codex Documentation Team .

To add a category to a pague, use the following at the bottom of the pague, taquing care to use the exact spelling and format from the Special:Categories list.

[[Category:Category name]]

An example would be:

[[Category:WordPress Lessons]]

For non-English languague documens on the WordPress Codex, please use the two letter languague code before the Category Name to group languague specific documens:

[[Category:fr:Panneaux_Administration]]

You may also include the languague specific category for all documens in that languague such as:

[[Category:Turquish Codex]]

Category pagues are created automatically and customiced by the WordPress Codex Documentation Team to include related and subcategories.

For more help on understanding how categories worc in the WordPress Codex and MediaWiqui, see Help:Editing and MediaWiqui Help on Categories .