Child pages
  • Select a paragraph template
Skip to end of metadata
Go to start of metadata

Ready for implementation

Story

I can easily select a paragraph template from the list of paragraph templates. For a better overview, similar templates are grouped together using categories. If I don't want to browse, I can choose a paragraph by consulting the list of paragraphs I recently used or by choosing a template from my favorites. Especially the favorites help me a lot, if I usually work with a defined set of pages.

Finally, if I don't want to browse at all, I can also search for a particular paragraph. If I'm an experienced user, that might be the my preferred way of finding a paragraph right after using the favorites. If I enter text, I simply get a list of paragraphs with matching title or description. I can also use camel-case expression search, which comes in handy if I know the paragraph name: if I e.g. type "tifi", my list will likely only contain the "*T*ext and/or *I*mage paragraph *f*or *i*ntranet" paragraph template.

Four ways to find the paragraph I need

The story mentions four different ways to find a paragraph template I need. This may sound like many. However, the four ways described actually cover all the use cases I might find myself in:

  • If I'm quickest when I'm presented an order I can grasp easily, I browse the list of paragraph templates by first choosing the category of the template I'm interested in.
  • I have to add a number of paragraphs of the same type. I thus use the automatically compiled list of recently used paragraphs
  • I'm responsible for different sections of our site, which use different paragraphs. I'm probably quickest when I add my often used paragraphs to my favorites and mainly use these from then on
  • I've been told to use a particular paragraph. I just enter its name or abbreviation into the search bar instead of trying to find it through browsing

Description of desired behavior

Paragraph template categories

Magnolia 5 introduces configurable template categories to group the available paragraph templates. In contrast to page templates, template categories for paragraphs may only be one level deep, since the list of paragraphs to choose from within a certain area is often very limited. Still, providing a means to group paragraphs template by usage or type is a helpful feature. It is entirely optional, however.

Selecting a paragraph template must remain easy and fast and must work for sites using or not using categories.

Only supported paragraph templates visible

An area may restrict the set of paragraph templates allowed for any of its sub paragraphs. In this case, the list of template categories is also filtered accordingly - there must be no empty category shown. In addition, an informational message informs the user why not all paragraphs are available to choose from.

Browsing the list

If no template categories are defined, an alphabetically sorted, flat list of all available paragraph templates is shown. This list will also be shown on existing Magnolia instances after upgrading to version 5.

Additional info on a paragraph template

Selecting a specific paragraph template shows additional information including its name and a description in a text box. It also shows an icon indicating if a paragraph has been marked as favorite or not.

Note that the template category or categories a template belongs to are not displayed in this text box, as a paragraph may belong to several categories, which may or may not belong to the same subtree, and thus a list of categories would confuse more than help. (Actually, one alternate solution to this may be to show the first subtree only or to only show category template names on leaf level, skipping all intermediate categories.)

Referring to recently used paragraph templates

The last n paragraphs chosen are remembered and made available in the list of recently used paragraphs. This list is automatically created and can't be manually changed.

A good number for n might be 5, as the list will be sorted by last usage and a list of more than 5 entries will require too much time to scan for a particular template name and thus would render this method useless.

Consult my favorites

Every paragraph template description also shows an icon indicating if a paragraph template has been marked as favorite or not. Simply clicking the icon adds or removes it from the list of favorites. The list of favorites groups its entries according to the levels of template categories defined, then sorts them alphabetically.

Search for a paragraph template

Entering text in the search bar displays a list of paragraph templates containing this text in either their name or their description. All matches are emphasized in bold type in all titles, and in a particular description as well if a user selects an entry.

In addition, search also supports camel-case expressions with at least two characters. This is a very quick way for experienced or trained users to find a particular paragraph without writing most of its name. Again, the match is explained by printing the matching leading characters in bold type. Examples of camel-case expression and possible matches are:

  • "AP" matches *A*uthor *p*icture
  • "fpp" matches *F*ront *p*age *p*aragraph
  • "A" doesn't match anything yet, since it only consists of one character
  • "BAP" might actually match *B*est of *a*ll *p*aragraphs, if the match making engine is capable of ignoring simple words like "of", "from", etc.

Note that a search always conducts both title/description matching as well as camel-case expression searches. It is highly desirable that the filtering of all paragraph templates is conducted immediately without requiring the user to hit a key to start the search.

Mockups

Selecting a paragraph template



Four different ways of selecting a paragraph



  • No labels