template-pattern-file.mdx 1.88 KB
Newer Older
1
2
3
import Term from '../src/components/Term'

---
Rieks Joosten's avatar
Rieks Joosten committed
4
id: pattern-<ExistingScope>-<NewPattern>
5
6
title: Pattern: <NewPattern> (Scope: <ExistingScope>)
---
Rieks Joosten's avatar
Rieks Joosten committed
7
<!--A %%pattern%% captures a set of %%concepts:concept%%, relations between them, and rules or constraints that (instances) thereof comply with. As such, it is a concise and possibly formal description of a coherent set of ideas, a mental model if you will, that can be used to facilitate one's thinking about/with these concepts.
8
9
10
11
12
13
14
This file documents a pattern called `<NewPattern>` within the scope of `<ExistingScope>`.
Before completing this template, please change every instance of 
- `<ExistingScope>` into a text that refers to the %%scope%% within which the %%pattern%% is to be defiend;
- `<NewPattern>` into the name that will be used within `<ExistingScope>` to refer to that %%concept%%.
Then, provide contents for the sections as you wish. You MUST provide contents for the sections 'Scope' and 'Criteria'-->

## Scope
Rieks Joosten's avatar
Rieks Joosten committed
15
<!-- *REQUIRED* Short text (label, abbreviation) used to refer to the %%scope%% within which the %%concept%% is defined. The default is essifLab.-->
16
17
18
essifLab

## Purpose
Rieks Joosten's avatar
Rieks Joosten committed
19
<!-- Concisely describe what can you do with the pattern that is (at least) harder if you didn't have it.-->
20
21

## Introduction
Rieks Joosten's avatar
Rieks Joosten committed
22
<!-- Gently introduce the pattern, by referring to real-world situations and using colloquial terms, so that when someone has read the text, (s)he knows what it is about, and is ready to delve into the specifics of the pattern-->
23
24

## Notations
Rieks Joosten's avatar
Rieks Joosten committed
25
<!-- This (optional) section specifies the notations that are used, or refers to such a specification.-->
26
27

## <!-- any number of other sections, as is fit for describing the pattern -->
Rieks Joosten's avatar
Rieks Joosten committed
28
<!-- text as appropriate for such a section -->
29

Rieks Joosten's avatar
Rieks Joosten committed
30
<!--
31
32
33
---
## Footnotes

Rieks Joosten's avatar
Rieks Joosten committed
34
[//]: # This (optional) section contains any footnotes that may have been specified in the text above.
35

Rieks Joosten's avatar
Rieks Joosten committed
36
[^1]: the text for footnote [^1] goes here.
37

Rieks Joosten's avatar
Rieks Joosten committed
38
-->