name: front class: middle center inverse # File Header Structure - _Bringing value to thoughts_ ---------- #### Classifying ~ Tracking ~ Processing ~ Automation --- name: Description ## Description To support the handling of assets such as documents, lists, images, text files should have a _header_. The _header_ is a collection of items describing what the file is, and its status. Typical details are title, subtitle, tags, edit status, what is still todo. These details are called the [_meta_ information](../cheatsheets/meta-info.html). ### Advantages This enables the file to be... * tracked * for the author to make comments about what is still to be done, for themselves and for the team * to be later searched and be found and * later be processed by automation scripts, i.e. to be fed [into other systems](../solutions/automation.html#Scenarios). --- name: Structure ## Heading Structure .pull-left[ The meta block on the right is only a short example. There are other parts - see the [_Meta-Info_ help](../cheatsheets/meta-info.html) for more info. The block headings have _[brackets]_. If you are using a Markdown editor, the meta block will be shown as a heading. The comment marking ``` ``` are used to hide the text from the print output. ] .pull-right[ ``` ``` ] --- name: ToUse ## To use Either: * Copy an existing file and delete the text after the header. * When creating a new file, copy the header from another file. * Get the _header_ source from the directory [.wiring/tagging/file-header.en.md](../../../.wiring/tagging/file-header.en.md) where the extension _.en.md_ is an english version of the file (in Markdown format).