Support Forum

sp_BreadCrumbs & Sp_ColumnEnd inputs and reviews

KW Ken Wilson
Ken Wilson
Member
Member since Nov 2013
62 posts
Feb 13, 2014 · 8:31 pm · Edited

Please provide inputs, review and comment on the next two CODEX page revisions. I have added ‘Caps” to the start of all othe phrases and put (.) periods at the end of all the phrases.  If this is the desired format, I will go back to the original 3 pages and update them to conform.  Please let me know.

sp_Breadcrumbs;
1. Need overall review/comment of content and format.
2. There are no single quotes around user_trailingslashit(SFSITEURL). Is that correct?
3. Need input of text definition for ‘homelink’.

sp_ColumnEnd;
1. Need overall review/comment of content and format.
2. Major headings are <h2> not <h3> like previous pages.  Does it matter?  Should a standard be used?  Which one?
3. Need to revisit definition of ‘echo’.  Is this more descriptive?  Should ‘zero is false…’ be added?  Can this be different on different pages?
4. Should sp_ColumnStart(‘tagClass=spClear’); actually be sp_ColumnStart(‘tagClass’ = ‘spClear’);
5. Need review of changed description for •do_action(‘sph_BeforeColumnEnd’, $columnName, $a);. Added the word “before” into the text.
6. Need review of changed description for •do_action(‘sph_BeforeColumnEnd_’.$columnName, $a);.  Added the word “before” into the text.
7. •do_action(‘sph_ColumnEnd’.$columnName, $a);  was added to Actions & Hooks exactly as in code. 
        7a. Should it be do_action(‘sph_ColumnEnd_’.$columnName, $a); [add underscore after …ColumnEnd]?
       7b. Text currently incomplete.  Need input for text to follow it.
 

 

7 Answers

New Answer
MP Mr Papa
Mr Papa
Member
Member since Dec 2006
19,448 posts
Feb 14, 2014 · 12:52 am

SITEURL is correct…  its a #define constant…  we want to pass the constant, not a string of SITEURL…

homelink updated and revision published…

yes the headings should all be the same, ie h3

all the echo descriptions from page to page should match… cant think of any that would be different… so yeah, just grab from other pages if different…

#4 assume you mean in the examples…  no…  sp_ColumnStart(‘tagClass=spClear’); is correct…all the arguments are passed as a single string, with each argument separated by an &… for example:

function_call(‘arg1=value1&arg2=value2&arg3=value3’);

#7a  will work as is fine… but to be consistent, the code really should have an _ before the columnName…  I have updated the code…

updated the hook section…

page is still in revision…

YS Yellow Swordfish
Yellow Swordfish
Member
Member since Nov 2008
16,437 posts
Feb 18, 2014 · 3:46 am

Ken – can you help me out here…?

I am getting all of these impressive revision emails but – and perhaps I am missing the obvious – is there actually a way I can see the page as it will look with the changes you are making – as opposed to just being taken to the edit window to look at the html raw text? I do not see any way to do this…

KW Ken Wilson
Ken Wilson
Member
Member since Nov 2013
62 posts
Feb 26, 2014 · 11:52 am

Andy,

Sorry it has taken me so long to get back to you on your question.  I have not been onto the website for awhile. (Actually, I have been on the website, but had not been able to get into the admin area of the Codex until just now).

I know of two ways to look at the changes other than the hmtl text.

For “sp_ColumnEnd”

The link in the e-mail is: http://codex.simple-press.com/wp-admin/admin.php?page=rvy-revisions&action=view&revision=3171 

When you get to the page, you see the html raw text because in the upper right corner the “text” vs “visual” tab is selected.  To see the way the page will look, select the “visual” tab.

The other way that I know to “preview” the revisions is as follows:

Go to: http://codex.simple-press.com/wp-admin/.  On the left menu, hover over “Codex Entries,” and select “Codex Entries” from the submenu that appears. 

On the top of the Codex Entries page that comes up, select “Pending().” 

Find and hover over the Codex revision entry of interest (“sp_ColumnEnd”), then select “Preview” from the menu that shows up immediately under the file of interest.

Please let me know if this allows you to see the page the way you preferred to see it.

KW Ken Wilson
Ken Wilson
Member
Member since Nov 2013
62 posts
Feb 26, 2014 · 12:38 pm

Mr Papa said
SITEURL is correct…  its a #define constant…  we want to pass the constant, not a string of SITEURL…

homelink updated and revision published…

yes the headings should all be the same, ie h3

all the echo descriptions from page to page should match… cant think of any that would be different… so yeah, just grab from other pages if different…

#4 assume you mean in the examples…  no…  sp_ColumnStart(‘tagClass=spClear’); is correct…all the arguments are passed as a single string, with each argument separated by an &… for example:

function_call(‘arg1=value1&arg2=value2&arg3=value3’);

#7a  will work as is fine… but to be consistent, the code really should have an _ before the columnName…  I have updated the code…

updated the hook section…

page is still in revision…

 

Echo:  On our Friday call I want to discuss the completeness the various flag (echo, get, etc.) descriptions including indicating what happens for each state of the flag.  For each template tag the base description for the flag may be common, but there could be tailored words for what is displayed (e.g. “sp_LoggedInOutLabel”  displays ‘forum label html display code’;  “sp_LoginForm” displays ‘form html display code’.)

#7a:  It was said that the code was changed, but the revised page was not changed by adding the “_” to “do_action(‘sph_ColumnEnd_’.$columnName, $a)”.  Does the codex page need to be revised to add the “_”?