Contributing to the WordPress Codex


Published on

Presentation on how to contribute to the WordPress Codex by Lorelle VanFossen Tips, techniques, and information on how to edit and write on the WordPress Codex, the open source online manual for WordPress users. Ideal for WordPress Meetup and user groups for a WordPress Codex Night or to learn about how the main documentation for WordPress works. For more information on the WordPress Codex, see

Published in: Education, Technology, Business
1 Like
  • Be the first to comment

No Downloads
Total views
On SlideShare
From Embeds
Number of Embeds
Embeds 0
No embeds

No notes for slide

Contributing to the WordPress Codex

  1. 1. Example of a Codex User Page
  2. 2. Codex Toolbox MenusViews Page Edit MenuToolbox Organization ManagementCodex Resources Recent Changes Random Page
  3. 3. What Links Here: Its about the connections Every page in the Codex: 1. Must have a link to it 2. Must link to another page
  4. 4. WordPress Codex Article Features Page: The article page Discussion: The "chat" about the article and supporting documentation Edit: Edit the article History: History of edits and changes
  5. 5. Discussion
  6. 6. Signature with user page link and timestamp:4 tildes ~~~~Triggers a notice to theuser that a comment iswaiting, part of thecommunication system.
  7. 7.  Summary: Add Twitter-style information on edit. This is a minor edit: Corrected spelling, link fixes, mark as minor edits. Watch Page: This adds to your "watch list" to monitor. Show Preview: Shows preview before publishing. Show Changes: Shows comparison of edits. Save Page: Publishes changes to the public. Editing help: Opens help file with editing tips and techniques.
  8. 8. Keep this open in a tab as reference
  9. 9. == Section Title ==An empty line after the end of a paragraph starts a new paragraph, just likein the WordPress HTML Editor.To make italic use two quote marks.To make bold use three quote marks. Example Writing in the=== Sub-Section === WordPress CodexTo create bullets, you use the asterick.* To create numbered lists # You use a pound sign. # Double the asterick (**) or pound (##) to create nested lists.* To make a link: # Internal Link [[WordPress Features]] # Internal Link Different Text [[WordPress Features|the features of WordPress]] # External Link: [ Lorelle on WordPress] # Categories: [[Category:WordPress Lessons]]* Links in red do not exist.
  10. 10. Recent ChangesThe heart beat of theWordPress Codex.Tracks all Codex activity.
  11. 11. Special Pages isyour Codex guide tothings to do
  12. 12. current unofficial to do list for theCodex team
  13. 13. How to add to the task lists:1. Add recommendations/ideas in the comments.2. Be as descriptive as necessary so others will understand and take action.3. Include a link to the article or related articles.
  14. 14. WordPress Meetup Group Task ListThe following are example group tasks for a WordPress Meetupgroup.The group should have access to one or more computers.Groups can consist of an individual or up to 6 people. The groupcan divide up the work and consult with each other on the bestchoices and decisions.Recommend groups divide up projects alphabetically, or dealwith similar tasks in reverse alphaetical order so they arent allworking on the same documents.If a task cannot be accomplished, a member should put it on a tolist on the WP Docs Team Task List.
  15. 15. Common Notifications to AdminstratorsPlease add the following to the top or bottom of an article whereappropriate. Delete: {{rfd}} Deprecated: {{Deprecated}} Needs Editing: {{Copyedit}} Incomplete or Short: {{Stub}} Old Pages by WP version: {{Oldpage|WPVersion}} = {{Oldpage|1.5}} Old Pages/Archaic: {{Datedpage|Date}} = {{Datedpage|March 24, 2006}}
  16. 16. PDX Meetup Codex GroupsWanted Pages of links created on other articles to an article thatdoesnt exist. 1. Is the page link misspelled? 2. Has the page moved? 3. Was the article deleted? 4. Is more action needed? A new article? Add it to the task list.
  17. 17. PDX Meetup Codex GroupsDead End and Lonely Pages End Pages do not link to any other pages in the Codex.Lonely Pages are not linked to or from other pages in theCodex. They are orphans.They need to be linked back to: 1. Categories 2. Other pages 3. Core reference pages (Function References)
  18. 18. PDX Meetup Codex GroupsSearch and ReplaceSearch and replace the following terms whereappropriate: 1. Dashboard – It is the Administration Panels or Administration Screens. 2. Admin Panels – same 3. Blog – WordPress now uses "site" 4. Look for other archiac User Interface terms
  19. 19. PDX Meetup Codex GroupsCategories Pages: Need categories.Wanted Categories: Pages with a category that doesntexist or match existing categories. 1. Is the category link misspelled? 2. Is it a synonym? 3. Does it need adding? [[Category:Category Name]]
  20. 20. PDX Meetup Codex GroupsRandom Pages Checkers around the Codex and look for trouble. 1. Check spelling and grammar. 2. Check for links to core elements or topics. 3. If the page needs additional attention, mark it with [[Category:Copyedit]] and list it on the WPDocs Task List site.
  21. 21. PDX Meetup Codex GroupsGlossary, edit, correct, add to the WordPress CodexGlossary. Include links to related articles in the Codex.
  22. 22. PDX Meetup Codex GroupsWordPress in Your Language external links to international language support sitesneed to be checked and verified, updated if necessary orremoved.
  23. 23. PDX Meetup Codex Groups TOC Sherlock Holmes Your assignment, if you choose to accept it, is to track down EVERY page in the Codex and match it to a Table of Contents. Add to TOC task on WPDocs Task List.
  24. 24. PDX Meetup Codex GroupsCopyEdit uses a special tag "Copyedit" to designate pagesthat need attention or havent been reviewed. 1. If the page is complete, remove copyedit category. 2. If it needs more work, do it or list it on the WPDocs Task List site.
  25. 25. The To Do List of the Codex
  26. 26. PDX Meetup Codex GroupsMiscellaneousUnused Files: Look for unused files that should be used or should bedeleted. Pages – short for a reason or incomplete? Pages – long for a reason or candidates for breakup? Pages – Are they still relevant or kept for history?
  27. 27. WordPress Codex Docs Team Resources Link [[WordPress Features]]Internal Link Different Text [[WordPress Features|the features of WordPress]]External Link: [ Lorelle on WordPress]Categories: [[Category:WordPress Lessons]]