[wp-meta] [Making WordPress.org] #1: Add callout boxes to handbooks

Making WordPress.org noreply at wordpress.org
Thu Aug 15 01:52:53 UTC 2013

#1: Add callout boxes to handbooks
  Reporter:  siobhan  |      Owner:
      Type:  task     |     Status:  new
  Priority:  normal   |  Component:  Handbooks
Resolution:           |   Keywords:

Comment (by kpdesign):

 Replying to [comment:3 jerrysarcastic]:
 > In chatting with Eric (sewmyheadon) there was some confusion as to what
 the difference would be between [tip] and [more-info] and how they would
 be used. To avoid having future editors ask the same question, I
 consolidated them for the time being. I've also added a new shortcode
 called [note] for your consideration.

 Just my thoughts:

 [tip] would be used within the content for a brief bit of info (blue box).
 I think notes could be included in this as well, not sure we need a
 separate [note] shortcode?

 [next-steps] block will include Next Steps, Credits, Learn More,
 References, More Info, etc. - all the things that go at the end of the
 page (green box). Not sure we need a separate shortcode for [more-info].

 [warning] will also be used within the content to alert read to potential
 problems (red box).

 [checklist]: To my knowledge, there shouldn't be any checklists on the
 introduction page once the handbooks are complete. Can you give me an
 example of something we would need a checklist for in a handbook? Also,
 couldn't we use the P2 checklist functionality (o Item 1, o Item2, etc.)

 > About the [draft] shortcode, How would this be used in practice? To mark
 sections (of an existing page) that are still in draft form or to mark an
 entire page as a draft?

 I think [draft] would be used to mark an entire page as a draft. The block
 should probably include the person's name who is working on the page so
 other authors could contact them about collaborating or corrections. I
 could also see it used on a page section, but not often.

 When we were in Cincinnati, you, @drewapicture and I talked about these
 shortcodes, and came to the conclusion that we really only needed 5 -
 [draft], [red], [blue], [green], and [yellow] - to keep it simple. A list
 could be made for authors to reference which shortcodes are used for what
 items, and included in the style/template guide in the Make/Docs handbook.
 Regardless of what we call them, I think we need to keep the number of
 shortcodes to as few as possible.

 I love how the boxes look, but do have a style suggestion: please don't
 italicize the text in the callout boxes, as the author may need to insert
 their own italic styling for a portion of the text in the box.

Ticket URL: <http://meta.trac.wordpress.org/ticket/1#comment:5>
Making WordPress.org <http://meta.trac.wordpress.org/>
WordPress blogging software

More information about the wp-meta mailing list