Configuring s2Member Restriction Options

patdumond commented 8 years ago

KB Article Creation Checklist

[x] Write initial draft for this KB Article; label this issue draft and either questions or tutorials
[x] Add required YAML configuration
[x] Add Tags for this KB Article to the YAML config (see YAML Keys (Explained))
[x] Edit and finalize draft for publishing (remove draft label, add draft-finalized label)
[x] Create Markdown file for this Article (remove draft-finalized label, add pending label)
[x] Publish KB Article (remove pending label, add published label; leave this step for the Project Lead)

KB Article Published @ s2member.com
:page_with_curl: See: Configuring s2Member Restriction Options

:octocat: View Markdown File | :pencil2: Edit Markdown File

patdumond commented 8 years ago

@jaswsinc, @raamdev: First draft submitted for review. I haven't added the screenshots yet, but have marked their location with something like [insert image here screenshot.jpg]. MS Word counts 2858 words (not counting the GitHub header).

jaswrks commented 8 years ago

Woohoo! :-)

The s2Member panels discussed in this article are:

The checkboxes in this list seem out of place to me.

Instead of - [] TODO item. just use - List item. minus the [].

For example, 1,2,3,all-newspapers protects several Post IDs and all Posts of type: newspaper.

Add backticks around 1,2,3,all-newspapers and newspaper.

deals with search results and menus as well as feeds.

I think this could be my issue. It looks like some of this was pulled from the Dashboard. If you can add a comma before , as well as feeds. it would be an improvement there I think.

Example: 1,2,3,34,8,21

Same thing here with backticks; i.e., Example: 1,2,3,34,8,21

Replacement Codes: You can use these Replacement Codes in URI Restrictions:

If you can reformat these as individual list items instead of a single paragraph like I did (with one after the other) it would go a long way toward cleaning that up I think.

%%replacement_code%% ... description.
etc., etc.

patdumond commented 8 years ago

@jaswsinc, @raamdev:

I added screenshots and made a lot of revisions - cleaning up the bad markdown, formatting, and some grammar. I made the changes recommended by Jason: either before or after I saw his comment. ;)

This is ready for review.

raamdev commented 8 years ago

Awesome! I learned a few things about s2Member while reviewing this. 😆

There were only a few minor things that I found needed fixing:

Custom Post Types

I noticed this is linking to a Google link that redirects to the page I believe you intended to link to: https://www.google.com/url?q=http://codex.wordpress.org/Post_Types&sa=D&ust=1462379119947000&usg=AFQjCNHuQ5dqjH0IUN8DSI1sddsCjWPfYA

Please keep in mind that when you Google something, often the links in the Google search results are not the direct links to those pages in the search results, but to a Google redirection URL. This has caught me by surprise many times. :-)

What do I enter?

(This is under Post Access Restrictions.) I suggest changing this header to "Restricting by Post IDs and Custom Post Types".

Tip: Can't find your Post IDs? Get WP Show IDs

I suggest moving this to just above the screenshot.

query_posts("suppress_filters=true");
get_posts() auto-suppresses filters

Please make this a list like this:

query_posts() - ("suppress_filters=true");
get_posts() - auto-suppresses filters

A specific Post or Page that is protected by s2Member might contain [...] would be unable to access the Post or Page without also having

It looks like there's a problem with the Markdown on both of those lines.

Note: the word all does not work here.

Please put "all" in code style: all

patdumond commented 8 years ago

@raamdev: Made the requested revisions. Ready for final review.

raamdev commented 8 years ago

@patdumond You still have s2member in the tags list for the YAML.

Also, this list still doesn't look like right in your article (it should not all be in a code block; "auto-suppresses filters" is not part of the code and ("suppress_filters=true"); is not part of the query_posts() function; it's just an example of a parameter that can be passed to that function):

query_posts() - ("suppress_filters=true");
get_posts() - auto-suppresses filters

patdumond commented 8 years ago

@raamdev: I think I've got it now. Removed s2member from the YAML tags. Made Auto-Suppresses Filters a bolded "header" for the code.

raamdev commented 8 years ago

Made Auto-Suppresses Filters a bolded "header" for the code.

I'm sorry, but that's still not right. This is what the Markdown should look like:

- `query_posts()` - `("suppress_filters=true");`
- `get_posts()` - auto-suppresses filters

patdumond commented 8 years ago

@raamdev: Done.

raamdev commented 8 years ago

@patdumond Thanks! Reviewed, edited, and published. Approved as of 2016-05-20.

wpsharks / s2member-kb