we/jgdr
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

removed filename section

Browse source
This commit is contained in:
constantinos 2023-08-14 17:50:50 +03:00
parent f788c49332
commit 976e41bc93
1 changed files with 25 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
content/article/int-conventions.md
View file

@ -7,15 +7,22 @@ draft: false
keywords: keywords:
- internal - internal
abstract: | abstract: |
Conventions for filenames, etc. List of conventions to follow.
Leave `draft: true`
--- ---
# Dates # Date format
> DD.MM.YYYY > DD.MM.YYYY
as in 13.05.1998. In general, day first. as in 13.05.1998.
# File naming conventions
For file-naming conventions see ![Content creation instructions](article:int-content).
<!--
# File naming conventions # File naming conventions
- All **lowercase** - All **lowercase**
@ -27,15 +34,15 @@ as in 13.05.1998. In general, day first.
|-|-|-| |-|-|-|
| contributor | name-surname.md | `hugo new contributor/name-surname.md`| | contributor | name-surname.md | `hugo new contributor/name-surname.md`|
| editor | name-surname.md | `hugo new editor/name-surname.md` | | editor | name-surname.md | `hugo new editor/name-surname.md` |
| issue | issue-x.md | `hugo new issue/issue-x.md` | | issue | issue-x.md* | `hugo new issue/issue-x.md` |
| article | article-short-title.md | `hugo new article/article-short-title.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 (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` | | print (article)\*\* | p-article-short-title.md | `hugo new print/p-article-short-title.md` |
\* where x is issue number \* where x is issue number
\*\* creating a new print file can break the site, until \*\* 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.
# Files intended for *Internal* use -->
# 'int-' prefix for files intended for *Internal* use
Files purposed to be for internal use, and are *not public facing*: Files purposed to be for internal use, and are *not public facing*:
- start with `int-` , like this file `int-conventions.md` - start with `int-` , like this file `int-conventions.md`
@ -43,41 +50,21 @@ Files purposed to be for internal use, and are *not public facing*:
Their header file: Their header file:
- features the keyword `internal` - features the keyword `internal`
- the draft flag is set to true, as in `draft: true` - the draft flag is set to true, as in `draft: true`
- suffix the abstract with: Leave `draft: true`
# Images and attachments # Images and attachments
> static/issue-x/author/image.png
<!-- Place images or other attachments related to a specific article in the appropriate subdirectory inside the `root/static/` folder as in:
# File naming conventions
Filenames are all lowercase. No spaces, no underscores, only dashes. ```
static/issue-x/author/image.png
```
# Contributors, Editors So that it can be referenced from an article like so:
> name-surname.md ```
![Image caption](/issue-x/author/image.png "optional mouse over/alt text")
```
as in `pippin-bar.md` *Note: When refencing an image or file provide a file path starting with a slash (`/`), and omit `static`.*
To create a new contributor do:
> hugo new contributor/name-surname.md
## Issues
> issue-x.md
where x is the issue number:
- issue-5.md
To create a new issue do:
> hugo new issue/issue-x.md
## Print files
Print files correspond to issues or articles.
> hugo new print/p-issue-5.md
or
> hugo new print/p-article-name.md
-->