Create plugins for Style Guide module [Task 1]

Task title: Create new preview elements for Style Guide module

Task description:

Background
The Style Guide module for Drupal provides a visual testing page for Drupal themes. Quickly compare the display of common elements across installed Drupal themes, and verify that selected themes addresses all common style elements.

Preparation
-- Download and install Drupal 7.
-- Visit the 'Appearance' page in the administration interface to find the Style Guide links.

New plugins

Using the API (styleguide.api.php, in the module download), create a patch to styleguide.styleguide.inc that adds preview elements only when optional core modules are enabled:

-- Aggregator (2 hrs)
--- theme_aggregator_item()
--- theme_aggregator_summary_items()
-- Book (2 hrs)
--- theme_book_navigation()
-- Comment (2 hrs)
--- theme_comment()
--- theme_comment_post_forbidden()
-- Forum (4 hrs)
--- theme_forums()
--- theme_forum_form()
--- theme_forum_list()
--- theme_forum_topic_list()
-- Image (4 hrs)
--- theme_image_style(), for all active styles.
-- Poll (2 hrs)
--- theme_poll_results()
--- theme_poll_vote()
-- Profile (4 hrs)
--- theme_profile_listing()
-- Search (4 hrs)
--- theme_search_block_form()
--- theme_search_result()
--- theme_search_results()

Additional core theme elements to include:

-- theme_breadcrumb() (1 hr)
-- theme_confim_form() (1 hr)
-- theme_feed_icon() (1 hr)
-- theme_filter_tips() (2 hrs)
-- theme_link() (1 hr)
-- theme_links() (1 hr)
-- theme_mark() (1 hr)
-- theme_maintenance_page() (2 hrs)
-- theme_menu_link() (1 hr)
-- theme_more_help_link() (1 hr)
-- theme_more_link() (1 hr)
-- theme_pager() (2 hrs)
-- theme_progress_bar() (2 hrs)
-- theme_system_powered_by() (1 hr)
-- theme_user_picture() (2 hrs)
-- theme_user_profile() (2 hrs)

Deliverables:

-- Patch(es) to include the desired features to the Style Guide module.

Resources:

Style Guide module: Style guide module

Primary contact:

agentrickard

Estimated time: Varies. May be split into separate tasks.

Drupal issue: DrupalIssue-949070

Time estimates are in comment #2. This may need to be broken into sub-tasks.

This was entered as one large task in Google. Can I go ahead and split it up in Google, or does one of the administrators need to do that?

Right now, the entire task estimate is 46 hrs.

Here's how I would break it up.

[Task 1: 8 hrs]
-- Aggregator (2 hrs)
--- theme_aggregator_item()
--- theme_aggregator_summary_items()
-- Book (2 hrs)
--- theme_book_navigation()
-- Comment (2 hrs)
--- theme_comment()
--- theme_comment_post_forbidden()
-- Poll (2 hrs)
--- theme_poll_results()
--- theme_poll_vote()

[Task 2: 8 hrs]
-- Forum (4 hrs)
--- theme_forums()
--- theme_forum_form()
--- theme_forum_list()
--- theme_forum_topic_list()
-- Image (4 hrs)
--- theme_image_style(), for all active styles.
-- theme_feed_icon() (1 hr)

[Task 3: 8 hrs]
-- Profile (4 hrs)
--- theme_profile_listing()
-- theme_user_picture() (2 hrs)
-- theme_user_profile() (2 hrs)

[Task 4: 8 hrs]
-- Search (4 hrs)
--- theme_search_block_form()
--- theme_search_result()
--- theme_search_results()
-- theme_breadcrumb() (1 hr)
-- theme_confim_form() (1 hr)
-- theme_filter_tips() (2 hrs)

[Task 5: 7 hrs]
-- theme_maintenance_page() (2 hrs)
-- theme_pager() (2 hrs)
-- theme_progress_bar() (2 hrs)
-- theme_system_powered_by() (1 hr)

[Task 6: 6 hrs]
-- theme_link() (1 hr)
-- theme_links() (1 hr)
-- theme_mark() (1 hr)
-- theme_menu_link() (1 hr)
-- theme_more_help_link() (1 hr)
-- theme_more_link() (1 hr)

Three of which are not on d.o. and one is dated after the creation of this module.

[edit] @sun (design module) already weighed in on the Style Guide issue queue and seems to have abandoned Design module in favor of Style Guide.

AFAIK, this is the only module with any actual momentum.

For simple text strings, the preferred use is styleguide_word(3) instead of styleguide_lorem(1, 3).

If that doesn't generate what you want, I need to fix the underlying API.

Love the module subdirectory. Follows contrib standards that we're all used to.

I wonder if the book implementation can be abstracted out a little bit, so that the $flat variable is generated by a styleguide function, like styleguide_book(), so we can use that for other possible tests.

Great. Always looking for new API elements. If you run across any items that should be abstracted, you can open a new issue or just post here.

There does appear to be a stray line or bad indent in the book part:

+      ),
+      1 => array(),
+      4 => array(

Not sure what that '1' piece is doing there.

Sweet. Will test and verify later.

This has now been split into 6 tasks. This is task 1, and contains:

[Task 1: 8 hrs]
-- Aggregator (2 hrs)
--- theme_aggregator_item()
--- theme_aggregator_summary_items()
-- Book (2 hrs)
--- theme_book_navigation()
-- Comment (2 hrs)
--- theme_comment()
--- theme_comment_post_forbidden()
-- Poll (2 hrs)
--- theme_poll_results()
--- theme_poll_vote()

Looks like Poll is not included in the patch. Is that module still in core :-)?

New tasks:

#989060: Create Plugins for Style Guide module [Task 2]
#989066: Create Plugins for Style Guide module [Task 3]
#989072: Create Plugins for Style Guide module [Task 4]
#989076: Create Plugins for Style Guide module [Task 5]
#989082: Create Plugins for Style Guide module [Task 6]

@dmitrig01

I went ahead and committed these changes to HEAD, after making some cleanup of the comments and changing how styleguide_word() handles text strings, which makes calling that function easier.

I still can't make the book_navigation piece display on Drupal CVS HEAD, though. So what's left of this task is:

-- A patch to /modules/book.inc that works. We can discuss if you have this working.
-- A poll.inc file, as listed above.

Nice work!

If we want to, I could make a bonus task to backport this to D6.

80% done.