Pattern : PATTERN(external)
PATTERN THUMBNAIL
- CONTEXT : You are writing a pattern that makes reference to
related patterns that appear later or are not included within the pattern or
pattern language you are writing. A basic understanding of these patterns may
be necessary for the reader to fully understand your pattern.
- PROBLEM : How do you refer to other patterns in a
concise but meaningful manner with minimum interruption of the
reader's "flow", so that the understanding of your pattern is
maximized?
- FORCES :
- Referencing
external patterns is an effective way to build upon, or
relate your work to existing patterns and pattern
languages.
- Including the
complete description of related external patterns within
your pattern will make it too large, and will distract
the reader from what you are trying to communicate.
- A basic
understanding of related external patterns may be
necessary for the reader to fully understand your
pattern.
- Some readers will
be familiar with the referenced external patterns, while
others will not.
- The most concise
way to refer to an existing pattern is to provide
sufficient information for the reader to obtain the
complete description of the referenced pattern,
typically using an author/year tag and a References
section.
- A reader may not
have the time (or energy) to obtain and read the
complete description of the referenced pattern, prior to
finishing reading and understanding your pattern. Even
if the reader does this they will be significantly
distracted from your pattern.
- SOLUTION : Include the Evocative Name of the external pattern within the text. The first time the external pattern is
referenced, provide both an author/year tag and a footnote with a brief (one or two sentences) "thumbnail" description of the essence of
the external pattern. The thumbnail should provide just enough information about the external pattern to maximize understandability of
your pattern.
- RATIONALE : Readers who are familiar with the external referenced pattern should not be distracted by the thumbnail footnote.
Other readers will be able to continue reading and understanding your pattern after they have read the thumbnail. Readers who want to
understand the referenced pattern in detail should be able to obtain its complete description using the information in the References
section.
- RELATED PATTERNS: Evocative Pattern Name helps reduce the need for Pattern Thumbnails.
- EXAMPLES : Several of the patterns in this language include External Pattern Thumbnails. For example, Evocative Pattern Name
contains a thumbnail reference to Buffalo Mountain7.
