Support Forum

Please review functions: sp_BreadCrumbs(), and sp_OpenCloseControl()

KW Ken Wilson
Ken Wilson
Member
Member since Nov 2013
62 posts
Jun 8, 2014 · 4:55 pm · Edited

Please review the 1 updated and 1 new Codex page listed below. Whomever reviews a page, please indicate it is ready to publish or list the additional work required to make it ready to publish.  If there is too much detail or if the detail is too specific, please provide input.

sp_BreadCrumbs()
0. Ready to publish after review.
1. Added ‘curClass’ to ‘args’ after ‘linkClass’ as in svn file and to definitions with Klasen’s def from sp_BreadCrumbsMobile() codex page.
2. Corrected value of ‘tree’ in the examples to match the text (‘tree’ = 1 for inline, 0 from dropdown). Please verify!
2. ‘truncate’ and ‘echo’ updated to standard definitions.
3. Changelog to 3/24/14 standard with “… sync’d to code Version 5.5.1.”
4. Related section added with sp_BreadCrumbsMobile() listed.

sp_OpenCloseControl()
0. Ready to publish after review.
1. New page developed and needs complete review.
2. Special notes indicates it is used in the Reboot theme.
2. Example came from spFooter.php for Reboot theme in svn.
3. Changelog to 3/24/14 standard.
4. Protections set & page marked as “complete.”

5 Answers

New Answer
YS Yellow Swordfish
Yellow Swordfish
Member
Member since Nov 2008
16,437 posts
Jun 9, 2014 · 4:47 am

sp_BreadCrumbs()

I donut think this is phrased correctly…

‘tree’: Display breadcrumbs inline. Zero for false, 1 for true.

It is the other way around. ‘tree’ means display as a tree so 1 for true, 0 for false. ‘inline’ would need to be set to false. Does that make sense?

sp_OpenCloseControl()

It needs the arg ‘targetId’ being added to the args list. There is no default but it IS a retirement that it is passed. It refers to the div or section (by it’s id) that is going to be opened/closed by the control.

KW Ken Wilson
Ken Wilson
Member
Member since Nov 2013
62 posts
Jun 9, 2014 · 1:55 pm

Thanks for the review, insight, and corrections.  Please let me know if there are further changes or if the pages are now ready to publish.

sp_OpenCloseControl()

Careless omission on my part. I will be more careful in the future.

Changed Description to match code header: sp_OpenCloseControl() – Generic Open and Close function.

Added ‘targetId’ => ‘ ‘ to $args.

Added definition: ‘targetId’: CSS ID for Div or section to be opened or closed.

sp_BreadCrumbs()

I believe the text for ‘tree’ has always been incorrect.  I didn’t detect the error in my updates. Experimentation showed ‘tree’ = 1 could provide a “tree” or tiered configuration with successive items either below and to the right or just below the previous item.  I tried to indicate that it the new text.  Let me know if it is too much.

‘tree’: Flag to indicate whether to display breadcrumbs in a “tree” / tiered fashion (below and possibly to the right of the previous one) or “inline” (on same line, but to the right of the previous one). One (1) is true and displays the “tree” configuration . Zero (0) for false and displays the “inline” configuration.

I went back to the original Examples before I attempted to modify them in this update.  I expanded some of the text (“dropdown” to “dropdown / tiered”) and corrected the error in the value of ‘tree’ in the 3rd example so it supported the “inline” text statement. 

Do you think ‘dropdown’ should be removed in case it might be confused with the look of a dropdown menu?

******

Thanks.

YS Yellow Swordfish
Yellow Swordfish
Member
Member since Nov 2008
16,437 posts
Jun 10, 2014 · 2:46 am

Personally think these are both fine now… I say go with them.