in the the plugin requirements section, the formatting seems off…  seem to have br tags instead of p tags… that is, the section is not formatted in paragraphs…  lines have line breaks but the wrong kind… they should be in paragraph forum like rest of sections..  looks mainly like first two sentences are wrong…

If at a later date they are included in all the then current themes and if the default positions and layouts are acceptable

doesnt flow well…

in plugin install and activation section, we cannot refer to the kind of plugin location… as mentioned previously, it is not guaranteed to be wp-content/sp-resources/forum-plugins….  the last two parts of the path are optional and user definable…

this plugin is not since 5.0…  it was first available with version 5.5 so should list that…

what is the purpose of listing ticket 4398 in the changelog???  there is likely many more tickets that have been included in this plugin… is that a code change or codex change ticket? if later, not sure of purpose… if former, probably needs a more complete list…  guess my recommendation would be to remove that reference…

general question for plugins in the codex… should we have a section on translation and offer a link to the glotpress site where the plugin specific translations can be downloaded?

generally pretty happy with it….

Thanks for the review. I have tried to address each of items. 

in the the plugin requirements section, the formatting seems off…  seem to have br tags instead of p tags… that is, the section is not formatted in paragraphs…  lines have line breaks but the wrong kind… they should be in paragraph forum like rest of sections..  looks mainly like first two sentences are wrong…

The section in question was copied from the published Plugin: Topic Status, so I imagine it has the same problem. 

Okay, I edited the section by removing the manual carriage returns and putting <p> and </p> around the 3 pieces of text.  After saving and re-editing , the format is changed but I do not see <p> or </p> on the page. 

Is this now formatted the way you want? If so, I will go back and change Plugin: Topic Status.

If at a later date they are included in all the then current themes and if the default positions and layouts are acceptable

doesnt flow well…

I was attempting to put in a boilerplate section so all new and modified plugins would address the need or lack of need to make Child themes.  I have replaced the original discussion with:

“This plugin does not currently have template tags so no suggestion is being made to make a Child Theme in the event template tags are to be modified.”

Please modify it to words you would want for a standard sentence in plugins without template tags or just tell me to remove the sentence and not address the issue until an update adds template tags.

in plugin install and activation section, we cannot refer to the kind of plugin location… as mentioned previously, it is not guaranteed to be wp-content/sp-resources/forum-plugins….  the last two parts of the path are optional and user definable…

These same words were used in Plugin: Topic Status so I copied them to this plugin.  I will need to get the correct words from here and change Topic Status.

After reading the codex page “Using Plugins”, I’m thinking it might be best to just remove everything from the section except the first sentence:

“Please see Using Plugins for additional information on obtaining and installing the Maintenance Mode plugin.” 

What do you think? My words don’t add much.

I will need to make some changes in the Plugin Administrative Options section if the activation paragraph is removed.

  this plugin is not since 5.0…  it was first available with version 5.5 so should list that…

I have updated it to say 5.5.0. Can you tell me how to find out that information for the other new plugins I am going to make?  Where does that information reside?

what is the purpose of listing ticket 4398 in the changelog???  there is likely many more tickets that have been included in this plugin… is that a code change or codex change ticket? if later, not sure of purpose… if former, probably needs a more complete list…  guess my recommendation would be to remove that reference…

That is the codex ticket saying a Maintenance Mode page is needed.  I have removed the reference.  I was trying to show that the codex ticket was satisfied in the page update.

A similar reference was made in Plugin: Topic Status to codex ticket 4433 with ‘statusClass” was added to sp_TopicIndexTopicStatus().  I will go back and take it out of Topic Status.

general question for plugins in the codex… should we have a section on translation and offer a link to the glotpress site where the plugin specific translations can be downloaded?

I am awaiting consensus from the team on this question. I’ll do what you guys agree upon.

I will go back to change Plugin: Topic Status after things are finalized in this plugin.

you know the drill from old work days   could review something every day and make changes…  looking good though!

plugin requirements…. yes, looks properly formatted now…

If at a later date they are included in all the then current themes and if the default positions and layouts are acceptable

in those words, was simply saying there was English and/or grammatical mistakes and the sentence structure was wrong… ie ‘in all the then”…  no worries if you want to have something about it – just needs to read right…

concur on using plugins changes…  reduce and link..

as to which sp version, kind of a crap shoot…  for new plugins, you can look in the plugin header and it has a version of sp that is required…  probably same for when it was created… older plugins or ones with changes, that may fall apart…  To be exact, I would have to look at when it was created in the download library…  feel free to ask as you do them if you want me to research exactly…

yes, I think removing the codex ticket reference is best…

to try to explain more, the simple press plugins do no to have to be located in wp-content/sp-resources/forum-plugins…  that is all optional to users to configure how they want… if you look at forum – integration – storage locations, you can see how users can define where they want to put the plugins…  so just trying to point out the code location for the plugins or plugins template tags, cannot be precisely stated and be correct…  Now, more than likely, very few, if any, users will actually move the forum plugins location around…  So I am probably worrying about a non-existent problem, just like to be accurate…   if you want to leave the location as is, then maybe just a little footnote that its the default location (what we set up by default at install) but users have the option to change…  or everyone could easily gang up on me on this one and I could just move on from it…

Lacking input on the localization, I would say add a new section and put a link to the available translation download…  ie http://glotpress.simple-press.com/plugins and then the actual plugin…

from my perspective then, ready to go… same for topic status with the needed tweaks mentioned for commonality…

keep em coming!

Please review the sections listed below and release for publishing, or modify, or provide info on changes still required.

“Plugin Installation and Activation” – I have modified the section but still mention the “forum-plugin” folder.  Details of activation were left in.

“Plugin Language Translation” – It appears the Maintenance Mode does not have translation files yet.  I put the write-up together without actually being able to make the process work on my site with another plugin having translation files such as Topic Status.  See what you think.  Whatever is finalized should become the ‘template’ for all the new and modified plugin pages.

Similar to Plugin: Topic Status, I do not have access when in the pending state to mark the page “Complete.”  It will remain “Being Worked On” until it is published.  At that time when I edit it, I will be able to mark it “Complete.”

Thanks.

activation… nope… sorry, but forum-plugins physical name iis not required to be part of the path…  maybe change to this:

If this path is changed, it is important to note that the plugin’s folder and its content need to reside in the forum plugins folder wherever you have moved it.

I think most of this text:

Back on the base page, select the “Simple Press Plugins” Project link then select the “Maintenance Mode” Sub-project link and then the “Version x.x” link to view the languages available to this plug and their language translation statistics. Select the language of interest to view the pages of English messages for the plugin under “original string”, to observe the current translation (if any), and to input a translation. NOTE: one must login to the site to edit/input a translation. Some plugins may not have language translation files.

is un-needed…  lets simply link to the plugin translation page:

http://glotpress.simple-press.com/projects/simple-press-plugins/maintenance-mode

there will always be just the latest (ie one subdir) there so no need to explain how to get to correct directory… I dont think we need to tell them how to translate strings either in the plugin page…  The NOTE is a good one though…  might want to add you use the export link at bottom and need the .mo file..

you might be mis-understanding the language selection plugin with this text:

The translations can be displayed using the Simple:Press Language and Theme Selection plugin. Learn more about it at Simple:Press Language and Theme Selection.

I think there is no need to talk about that plugin on each plugin page… the sole purpose of that plugin is for users who want to make their language available in more than one language…  most users just want to get single language of their site and that pluign is not needed…  any discussion of it should occur on its plugin page..

getting close!  thanks!

Please check these changes and the entire page one more time.  If any wording changes are needed anywhere on the page, please make them so the page can be published.  Your final corrections will be used as the template for future plugin pages.

Thanks.

Installation and Activation:

Sentence has been changed to approximately what was specified (expect I try not to write using “you”). The “forum-plugins” as the folder name has been removed.  So the path and the folder name can change? A plugin’s folder doesn’t need to reside somewhere in a folder named “forum-plugins.”  It could be in a folder named “Magic Stuff”, correct?

Plugin Language Translation:

I believe I have accomplished what was specified. The last paragraph has been changed.  Is it true that the translation files go into a sub-folder under the folder named “forum-language” (actually if this plugin had a file it should go in the sub-folder “sp-plugins”, correct?)  If not, please correct the wording to say what should be said.

installation… correct… it can be in any folder under wp-content called whatever you want… see the forum – integration – storage locations for details/examples…

translations… well same problem with forum-language and sp-plugins… those are customizable and not required…  by default, it would be wp-content/sp-resources/forum-languages/sp-plugins…  the text you have is not quite correct as it references only forum-languages (though you have it right in your post above this one)…

I would say make similar correct to the translation folder as you did for installation folder and then publish away!

thanks!

The Maintenance Mode Plugin codex page has been published, the progress updated to ‘complete’, and re-published. 

Let me know if issues still exist in Installation or in Language Translation or any other part of the page.

Installation now reads:

Please see Using Plugins for additional information on obtaining and installing the Maintenance Mode plugin.  As mentioned there the default location for plugin folders is …/wp-content/sp-resources/forum-plugins.  If this path is changed, it is important to note that the plugin’s folder and its content need to reside in the forum plugins folder wherever it has been moved and however it has been renamed. See Storage Locations for more information.

A similar section of Language Translation reads:

The Maintenance Mode plugin’s available language translation files with translation statistics, and message translations can be viewed at Maintenance Mode Translations. If available, export the file for the selected language to its proper forum language sub-folder as a “mo” file using the export link at the bottom of the page displaying the actual message translations for the language selected. The default location for plugin language files is …/wp-content/sp-resources/forum-language/sp-plugins. If this path is changed, it is important to note that the plugin’s language file needs to reside in the language sub-folder for sp plugins wherever it has been moved and however it has been renamed. See Storage Locations for more information.

Thanks.

sounds good… thanks!