70 lines
No EOL
2 KiB
Markdown
70 lines
No EOL
2 KiB
Markdown
---
|
|
title: "Conventions 🧾"
|
|
date: "2023-06-29T23:38:56+03:00"
|
|
author: "editor-put-your-name-here"
|
|
contributors:
|
|
draft: false
|
|
keywords:
|
|
- internal
|
|
abstract: |
|
|
List of conventions to follow.
|
|
Leave `draft: true`
|
|
---
|
|
|
|
# Date format
|
|
|
|
> DD.MM.YYYY
|
|
|
|
as in 13.05.1998.
|
|
|
|
|
|
# File naming conventions
|
|
|
|
For file-naming conventions see .
|
|
|
|
<!--
|
|
# File naming conventions
|
|
|
|
- All **lowercase**
|
|
- Use **dash as separator**
|
|
- No spaces
|
|
- No underscores
|
|
|
|
| Type | Filename convention | Creation command |
|
|
|-|-|-|
|
|
| contributor | name-surname.md | `hugo new contributor/name-surname.md`|
|
|
| editor | name-surname.md | `hugo new editor/name-surname.md` |
|
|
| issue | issue-x.md* | `hugo new issue/issue-x.md` |
|
|
| article | article-short-title.md | `hugo new article/article-short-title.md` |
|
|
| print (issue)\** | p-issue-x.md | `hugo new print/p-issue-x.md` |
|
|
| print (article)\*\* | p-article-short-title.md | `hugo new print/p-article-short-title.md` |
|
|
|
|
\* where x is issue number
|
|
\*\* creating a new print file can break the site if (a) the `print: ` target points to an inexistent file, or if (b) a public print item points to a non-published target.
|
|
-->
|
|
# 'int-' prefix for files intended for *Internal* use
|
|
|
|
Files purposed to be for internal use, and are *not public facing*:
|
|
- start with `int-` , like this file `int-conventions.md`
|
|
|
|
Their header file:
|
|
- features the keyword `internal`
|
|
- the draft flag is set to true, as in `draft: true`
|
|
- suffix the abstract with: Leave `draft: true`
|
|
|
|
# Images and attachments
|
|
|
|
|
|
Place images or other attachments related to a specific article in the appropriate subdirectory inside the `root/static/` folder as in:
|
|
|
|
```
|
|
static/issue-x/author/image.png
|
|
```
|
|
|
|
So that it can be referenced from an article like so:
|
|
|
|
```
|
|
|
|
```
|
|
|
|
*Note: When refencing an image or file provide a file path starting with a slash (`/`), and omit `static`.* |