Mr Papa said
a few comments…
in couple places, namely the template tags section, you have a lot of duplicate blank lines… those wont show up when displayed… so, to me, they make it hard to read for no value on front end… but might just be me…
administrative options… the components of each element should be indented one more level for readability… I have done the “Configuring Topic Status Sets” so you can see what the markup for that would look like…
same indentation comment for ‘plugin usage’… also within plugin usage, pick either bullets or numbers, but not both…
template tags used in plugin… nice use of anchor!
actions and hooks used in the plugin… is this correct? you only listed the ones in the template functions… but the plugin may very well have additional actions and filters outside of the template functions… might be complete for this plugin – dont know without looking – but it should probably be a complete list… best way is to search the plugin root directory and lower for ‘apply_filters’ and ‘do_action’… think its okay to list ones outside the template functions then link to the tags ones like you do…
recommend deleting the plugin source code section.. not really value added and the location you reference can be wrong… the plugin is not required to be located in that location – users can move it to where they like..
why two hr tags before template tags? looks odd and you have one after each one, they seem to stand out…
not sure we need a change log for each template tag… could be confusing with the overall plugin one… lol, and need to be somewhat synced… know what you were trying to do, but not sure its clear and or lots of value… others may think differently…
remove source code section too in the template tags section…
overall, looks pretty good!
as to the topic status question at end, did you look in the options section for it? ie click on the options button…
Steve,
Please review the pending Plugin: Topic Status codex page as I have edited it and let me know what further changes are needed.
I did not make all the changes exactly as you specified and have provided my rationale below. Please specify in your response how to proceed with each.
P.S. I didn’t understand your answer to my 2 questions? Was it meant to cover both?
Rationale
1. I reduced some the of the duplicate blank lines, but I like space between sections in the text mode of editing.
2. Admin options: I have indented components of each element.
3. Plugin Usage: I removed the numbers and references to them. I have used several levels of indenture.
4. Actions and Hooks:
A. I searched for those items in my local site under …/sp-resources/forum-plugins/topic-status and no others showed up. Is that not where you meant to search?
B. I agree with the approach you discussed if there are ‘apply_filters’ and ‘do_action’ in other than the template tags.
5. Plugin Source Code: section removed.
6.Two hr tags: I used them to separate the Plugin Section from the Template Tag section. I used the single hr tag to separate the Template Tag heading/discussion from the Template Tags themselves. I used a single hr tag to separate the 2 Template Tags.
If you have a preferred technique, please edit the file appropriately and I will use that in future Plugin codex pages.
7. Template Tag Changelog: Changed “Plugin Changelog” to “Plugin and Template Tag Changelog” so changes to Plugin and Template Tags can be listed in one place. I updated the section with recent Template Tag changes and codex ticket info.
Left the boilerplate “Changelog” in the Template Tag but changed wording under it to: “See Plugin and Template Tag Changelog for Template Tag changes and Codex page syncing to code versions.” This would be the same in all Template Tags in all Plugins if you agree.
8. Source Code: I disagree with removing the “Source Code” section from Template Tags in Plugins, but tell me to remove it (one more time) and I will.
It is there to help the users, correct? Having the filename where the template tag can be found should be helpful.
Why is listing the file where these template tags can be found less important than for the Display Template Tags?
I also like consistency in the codex sections regardless of the type of template tag.
9. I asked 2 questions. I don’t understand which your answer is for. Let’s focus on the first question because it affects the codex.
Q1. Where if any place should sp_TopicIndexTopicStatusTag() and sp_TopicStatusTag() be used?
I am asking if sp_TopicIndexTopicStatusTag() and sp_TopicStatusTag() should replace sp_TopicIndexTopicStatus() and sp_TopicStatus() in the Plugin codex page.
Is …Tag() the real name of each the Template Tag?
I am uncertain which ones to use because:
A. In sp-topicstatus-template-tags.php, the template tags are
function sp_TopicIndexTopicStatusTag($args=”, $toolTip=”)
function sp_TopicStatusTag($args=”, $toolTip=”, $label=”)
B. Then in sp-topicstatus-plugin.php, relationships are shown as:
# ======================================
# TEMPLATE TAGS
# ======================================
# ———————————————-
# ForunView – In row Topic Status
# ———————————————-
function sp_TopicIndexTopicStatus($args=”, $toolTip=”) {
include_once(SPTSLIB);
include_once(SPTSTAGS);
sp_TopicIndexTopicStatusTag($args, $toolTip);
}
# ———————————————-
# TopicView – Anywhere
# ———————————————-
function sp_TopicStatus($args=”, $label=”, $toolTip=”) {
include_once(SPTSLIB);
include_once(SPTSTAGS);
sp_TopicStatusTag($args, $label, $toolTip);
}
Have a safe Business Trip!
might be worth just mentioning that the reason for setting up the keys allows for extra status entries to be inserted at a later date if needed – or even re-ordered – while maintaining the integrity of the data assigned to topics.