205 lines
4.7 KiB
Markdown
205 lines
4.7 KiB
Markdown
---
|
|
id: README
|
|
aliases:
|
|
- home
|
|
- zmVault
|
|
tags:
|
|
- destiny/permanent
|
|
- topic/meta
|
|
---
|
|
# zmVault
|
|
|
|
> [!info]
|
|
> This note is on the meta-formatting of this repository.
|
|
> For contents, prose conventions, etc. see [[this-notebook]].
|
|
|
|
## Syntax
|
|
|
|
Notes are written in [Obsidian-flavored markdown](https://help.obsidian.md/),
|
|
which is partially reimplemented by [Markdown Oxide](https://oxide.md/)
|
|
for use in editors other than Obsidian.
|
|
|
|
Novel syntax implemented by Obsidian plugins should be avoided.
|
|
|
|
## Tags
|
|
|
|
These tags are presented in an associative order.
|
|
|
|
### #destiny
|
|
|
|
`#destiny` describes the permanency of an item.
|
|
It does not necessarily reflect its current [[README#status]].
|
|
|
|
#### #destiny/fleeting
|
|
|
|
The content of an item tagged `#destiny/fleeting`
|
|
will ultimately be absorbed into another note
|
|
and the file deleted.
|
|
|
|
These notes may deviate from standard formatting.
|
|
|
|
#### #destiny/permanent
|
|
|
|
Notes tagged `#destiny/permanent` are intended for long-term use.
|
|
|
|
They are expected to reflect standard formatting
|
|
and should be heavily tagged and linked.
|
|
|
|
### #status
|
|
|
|
`#status` reflects the remaining work necessary
|
|
to bring an item to the standard of its [[README#destiny]].
|
|
|
|
#### #status/incomplete
|
|
|
|
Beyond intent, the note offers little to go on.
|
|
|
|
#### #status/draft
|
|
|
|
The main content of the note is present, but:
|
|
* text may need to be reflowed
|
|
* links may need to be added
|
|
* citations may be necessary
|
|
|
|
#### #status/complete
|
|
|
|
The text flows well,
|
|
the note is sufficiently tagged and linked,
|
|
and citations are included as appropriate
|
|
|
|
### #topic
|
|
|
|
Notes can and usually will have multiple topic tags.
|
|
|
|
#### #topic/meta
|
|
|
|
Relating to the structure or intent of this notebook.
|
|
|
|
#### #topic/software
|
|
|
|
Relating to specific software written by others,
|
|
or hypothetical software functionality I've conceived.
|
|
|
|
The latter I generally relegate to [[README#destiny/fleeting]],
|
|
to be absorbed into the specifications of the relevant project
|
|
when the idea is sufficiently developed.
|
|
|
|
#### #topic/automation
|
|
|
|
On the subject of lightweight scripts
|
|
that could reduce redundancy in processes,
|
|
without requiring fundamental change.
|
|
|
|
#### #topic/electrical
|
|
|
|
Relating to electrical installation,
|
|
including:
|
|
* code
|
|
* material
|
|
|
|
#### #topic/estimating
|
|
|
|
Relating to the field of cost estimation,
|
|
as understood in [[construction-estimating]]
|
|
as well as other industries.
|
|
|
|
This topic also includes concepts that may be useful to estimation,
|
|
but that aren't widely understood to be.
|
|
|
|
#### #topic/math
|
|
|
|
#### #topic/risk
|
|
|
|
Relating to mathematical and abstract concepts of [[risk]].
|
|
|
|
#### #topic/organization
|
|
|
|
On the subject of [[optimal-patterns]] for processes
|
|
of varying importance.
|
|
|
|
#### #topic/other
|
|
|
|
Notes relating to subjects not relevant to this notebook's [[supertopics]],
|
|
but that I include for the convenience of editing them in Obsidian.
|
|
Some standouts include:
|
|
|
|
* [[birds|Birdwatching]]
|
|
* [[list|Warhammer 40,000]]
|
|
|
|
### #occupational
|
|
|
|
Items tagged `#occupational` include information and instructions
|
|
relevant to my current occupation
|
|
that may not reflect [[construction-estimating]] practice
|
|
in the wider industry.
|
|
|
|
> [!info]
|
|
> This tag is largely separate from the wider vault.
|
|
> I would probably move them to their own repository
|
|
> were it not for the complexity of preserving the version history of both.
|
|
|
|
#### #occupational/systems
|
|
|
|
> [!important]
|
|
> Notes tagged `#occupational/systems/*` include information as understood by PDI,
|
|
> which is not necessarily consistent with (and often sharply deviates from)
|
|
> wider industry understanding.
|
|
|
|
### #type
|
|
|
|
#### #type/idea
|
|
|
|
Items of `#type/idea` are recommendation
|
|
that I do something in the future,
|
|
possibly including some details of how to go about it.
|
|
They have the minimum amount of information
|
|
necessary to allow me to return to them.
|
|
|
|
They are always? of [[README#destiny/fleeting]].
|
|
|
|
#### #type/guide
|
|
|
|
<!--TODO-->
|
|
|
|
#### #type/encyclopedia
|
|
|
|
Items of `#type/encyclopedia` are thorough,
|
|
use exact language, and include citations.
|
|
|
|
They describe concepts as they are, not as they should be.
|
|
|
|
#### #type/philosophy
|
|
|
|
Items of `#type/philosophy` are highly opinionated.
|
|
They describe concepts as I believe them to be.
|
|
|
|
They are always? of [[README#authorship/original]].
|
|
|
|
#### #type/anecdote
|
|
|
|
<!--TODO-->
|
|
|
|
#### #type/media-commentary
|
|
|
|
<!--TODO-->
|
|
|
|
### #authorship
|
|
|
|
`#authorship` reflects my claim to the content of an item
|
|
_in its current state_.
|
|
|
|
#### #authorship/original
|
|
|
|
Items of `#authorship/original` are primarily my own work.
|
|
Content from other sources is properly cited.
|
|
|
|
#### #authorship/other
|
|
|
|
> [!info]
|
|
> I'm unsatisfied with the name of this tag.
|
|
> It is subject to change.
|
|
|
|
Items of `#authorship/other` are not my own work.
|
|
They may be of one source a collection of several
|
|
without significant commentary.
|