Conditional Text ability needed for book pages

Created on 11 December 2010, over 14 years ago
Updated 25 March 2025, 13 days ago

As discussed at the Vancouver docs meeting, a fairly quick change that we could make to the Book Page node type would be to make an input filter that would allow for what's called in the technical communication world "conditional text".

The idea is that when you're writing a doc page that pertains to multiple versions of Drupal, for instance, you could mark some sections as relevant to Drupal 6, and others as relevant to Drupal 7, while the bulk of the page would be relevant to both D6 and D7. That way, we could avoid having to have two completely different versions of a page on d.o, when they only need to differ by a little bit.

I've filed this issue in the Doc project for now, so we can discuss the specs for what we want built. When specified, we'll need to move it to the d.o infrastructure queue so we can make an input filter that implements the spec.

The idea proposed (not fully spec'ed out yet) was something like this:
a) Have a "shortcode" that we could put into a book node, maybe:
[conditional: Drupal 6.x] (conditional d6 text goes here) [/conditional]

b) The input filter would translate this into a heading and a div, something like:

<h4 class="conditional-header">Drupal 6.x only</h4>
<div class="conditional"> (conditional text goes here</div>

c) There would be some CSS that would format this appropriately, probably highlighting the conditional code and maybe indenting it.

Once this is done, we would want to start a meta-project of consolidating our doc pages using conditional text.... but that's for later.

✨ Feature request
Status

Postponed: needs info

Component

Docs infrastructure

Created by

πŸ‡ΊπŸ‡ΈUnited States jhodgdon Spokane, WA, USA

Live updates comments and jobs are added and updated live.
  • docs infrastructure

    Infrastructure/code improvements related to documentation. The Core Documentation team uses this tag.

  • Usability

    Makes Drupal easier to use. Preferred over UX, D7UX, etc.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024