Login  Register

Re: AsciiDoctor's content strategy

Posted by mojavelinux on May 25, 2013; 1:22am
URL: https://discuss.asciidoctor.org/AsciiDoctor-s-content-strategy-tp237p240.html

One example of where content chunking is used already in AsciiDoc is in the man page structure (and backend).

Here's a snippet of a man page (from the git project):

= git-cherry-pick(1)

== NAME
git-cherry-pick - Apply the changes introduced by some existing commits

== SYNOPSIS
[verse]
'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff] <commit>...
'git cherry-pick' --continue
'git cherry-pick' --quit
'git cherry-pick' --abort

== DESCRIPTION

Given one or more existing commits, apply the change each one
introduces, recording a new commit for each.  This requires your
working tree to be clean (no modifications from the HEAD commit).

== OPTIONS
<commit>...:: Commits to cherry-pick.

In this case, the section title names are doubling as the role (which is fine, AsciiDoc is flexible that way). Suffice to say, the name, summary, description, etc can be extracted out of this structure cleanly. This chunking is precisely what Karen is talking about in her presentation.