Collection of ?s Encountered In Creating Codex Contributions…
The following are inconsistencies found in the Codex, or unclear conventions ('least to me), mostly related to grammar or terminology.
What is the term for a Dashboard view, like Edit Post: a Penal or a Screen?
"Screens" seems to be the more current term: Administration Screens. (And there's a Glossary#Screen entry, but none for Panel.)
But "Panels" is also used extensively: Using_Themes#Adding_New_Themes_using_the_Administration_Panel. (Even under "Use Proper WordPress Terminology" in Codex:Guidelines#Adding_a_New_Category.}
What is the term for a Edit Screen form, e.g. Publish or Page Attributes?
The .org codex uses both terms; the .com support pages use "module": http://en.support.wordpress.com/pages/page-attributes/
How do we refer to the name of a select menu?
For instance, above .com page uses "dropdown", "list", and "pull down". Are either of these three OK in Codex?
How to we text-format form element labels vs. user actions and selections?
E.g, Caps for label and Bold Caps for select-option/button values? E.g.:
"Go to the Bulk Actions dropdown, select Edit, and click the Apply button."
Do we capitalize Page and Theme but not post?
I read that somewhere -- I thought at Codex -- but can't find that info anywhere now.
Either term OK?
How do we refer to the active them dir path (or URL)?
WordPress Files uses: /wp-content/themes/themedir
wp_enqueue_script uses: /wp-content/themes/my-theme/
How should we (codex writer) refer to the codex reader's site name?
E.g, as in the login form link: ← Back to [Your-Site-Name].
Or in As in <title>: "[Your-Site-Name] › Log In"
How should we refer a generic domain name?
This URL seems the most common: http://example.com/wordpress.
But this is also used: http://your.domain.name/the/path.
By default the TOC hash-anchor to a header is the full text of the header. So, for instance, on a Login_Form page w/ a header == Where to Find the Login Page == has a href of Login_Form#Where_to_Find_the_Login_Page. Can that be made a better titlewd URL, like Login_Form#Where_to_Find w/o changing the header text?
Note: using HTML header, like <h2 id="use-this-anchor-text"> will make a TOC entry, but won't use the id text as the anchor.
Name a function w/ or w/ "()".
E.g: To print the post title use the the_title function. Or should we write: ...the_title() function?
Is "my_" the Codex's generic custom function prefix?
function my_cool_script() { // Inject cool here. }
When presenting code, should add_filter come before or after the function it calls? How about add_action?
add_filter( 'a_wp_hook', 'a_function' )
a_function() { // do stuff }
Most codex writers tend to put add_action before the function and add_filter after. Not sure if that's habit or protocol. I don't believe either PHP or WordPress care about the order.
Not questions, just things I've noticed in Codex…
Not a ?, rather an observation: Codex pages w/ images and lots of white-space, eg: Dashboard_Screen, are more inviting than those w/o, eg: Administration_Screens, esp. for new users.
Does Core talk to Docs; do Docs converse w/ Core? How do Codex writes find out about all the Core changes that may affected a Codex article theyve adopted?
Do we search thru tickets at Trac hoping to find one that relates. Do we sift thru changlogs, then pout thru Beta version code? These methods are neither efficient, accurate, nor comprehensive.
Speakin' o' which how does the docs mailist talk to Make.WP/Docs?
Just did my first Function Ref pg, and tried to follow the formatting/wording standard of other similar function pgs. But there must be at least five different standards in the Codex.
3 pages list APIs; none of the lists are the same: Developer_Documentation#APIs, WordPress_APIs, WordPress.org_API
Would be really helpful for Codex writers (and maybe for readers) to have a single sitemap page listing all Codex articles:
http://www.mediawiki.org/wiki/Extension:ManualSitemap
Updating plugs is a huge emphasis for WP, but there's no clear instructions about the Updates sceens on Managing_Plugins (nor on Updating_WordPress).
testing mediawiki sig (4 tildes): Hearvox 22:49, 21 April 2013 (UTC)