added heading ids for internal links for consistency !publish!
This commit is contained in:
parent
e0e2c2b1a4
commit
7b533e665d
5 changed files with 17 additions and 17 deletions
|
@ -17,9 +17,9 @@ abstract: |
|
||||||
Here we can list feature requests and issues for *Sandpoints*, or for this project in general.
|
Here we can list feature requests and issues for *Sandpoints*, or for this project in general.
|
||||||
After being discussed, issues and requests should be communicated to and discussed with the *Sandpoints* developers, ideally by filing an issue on the [Sandpoints repository](https://git.sandpoints.org/).
|
After being discussed, issues and requests should be communicated to and discussed with the *Sandpoints* developers, ideally by filing an issue on the [Sandpoints repository](https://git.sandpoints.org/).
|
||||||
|
|
||||||
To contribute an issue or request make a new subheading within [feature requests](#feature-requests), and add date and contributor. Resolved issues should be moved to the [resolved](#resolved) section.
|
To contribute an issue or request make a new subheading within [feature requests](#requests), and add date and contributor. Resolved issues should be moved to the [resolved](#resolved) section.
|
||||||
|
|
||||||
# Feature requests
|
# Feature requests {#requests}
|
||||||
|
|
||||||
## Expose item publication date (urgent)
|
## Expose item publication date (urgent)
|
||||||
|
|
||||||
|
@ -88,7 +88,7 @@ Necessary metadata fields seem to get lost in the transfer, like:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
# Resolved
|
# Resolved {#resolved}
|
||||||
|
|
||||||
## Add background to code blocks
|
## Add background to code blocks
|
||||||
|
|
||||||
|
|
|
@ -129,7 +129,7 @@ This will setup a new profile and also build a standalone web app of the library
|
||||||
The profile should now be visible in `accorder configuration -s`.
|
The profile should now be visible in `accorder configuration -s`.
|
||||||
To edit elements of a profile configuration follow instructions in `accorder configuration --help`.
|
To edit elements of a profile configuration follow instructions in `accorder configuration --help`.
|
||||||
|
|
||||||
## Build a portable library
|
## Build a portable library {#build-lib}
|
||||||
|
|
||||||
With accorder installed and a profile setup, to build a standalone web app of the library do:
|
With accorder installed and a profile setup, to build a standalone web app of the library do:
|
||||||
```
|
```
|
||||||
|
@ -140,7 +140,7 @@ This will generate a portable version of the Calibre library by adding in the li
|
||||||
1. a `BROWSE_LIBRARY.html` file, and
|
1. a `BROWSE_LIBRARY.html` file, and
|
||||||
2. a folder titled `static` with necessary dependencies.
|
2. a folder titled `static` with necessary dependencies.
|
||||||
|
|
||||||
## Build library catalogue
|
## Build library catalogue {#build-catalog}
|
||||||
|
|
||||||
To build a library catalogue that allows referencing library items from Sandpoints do:
|
To build a library catalogue that allows referencing library items from Sandpoints do:
|
||||||
|
|
||||||
|
@ -162,8 +162,8 @@ Note: The catalogue file can be opened and viewed with any text editor. It is fo
|
||||||
# Deploy library
|
# Deploy library
|
||||||
|
|
||||||
To deploy a library firstly use accorder to
|
To deploy a library firstly use accorder to
|
||||||
- [build a library standalone web app](#build-a-portable-library), and
|
- [build a library standalone web app](#build-lib), and
|
||||||
- [build a library catalogue](#build-library-catalogue).
|
- [build a library catalogue](#build-catalog).
|
||||||
|
|
||||||
1. Place the library catalogue at the folder `data/books/` of the project, as in:
|
1. Place the library catalogue at the folder `data/books/` of the project, as in:
|
||||||
```
|
```
|
||||||
|
|
|
@ -30,7 +30,7 @@ Thus, with the infrastructure in place, no programming is needed
|
||||||
|
|
||||||
To manage the site you first need to install:
|
To manage the site you first need to install:
|
||||||
1. [Git][] -- version control system.
|
1. [Git][] -- version control system.
|
||||||
2. [Hugo][] -- a static website builder ([see instruction below](#install-and-upgrade-hugo)).
|
2. [Hugo][] -- a static website builder ([see instructions below](#get-hugo)).
|
||||||
3. It's recommended to install the [Go Language][].
|
3. It's recommended to install the [Go Language][].
|
||||||
|
|
||||||
To manage the site you need the following tools:
|
To manage the site you need the following tools:
|
||||||
|
@ -41,7 +41,7 @@ To manage the site you need the following tools:
|
||||||
## Library management tools
|
## Library management tools
|
||||||
Library management requires Calibre, Accorder, and Zotero. For detailed instructions see .
|
Library management requires Calibre, Accorder, and Zotero. For detailed instructions see .
|
||||||
|
|
||||||
## Install and upgrade Hugo
|
## Install and upgrade Hugo {#get-hugo}
|
||||||
|
|
||||||
To install [Hugo][] for your system see [Hugo installation guide] -- Hugo is installed via a package manager, e.g. *Homebrew* for macOS or *choco* for Windows.
|
To install [Hugo][] for your system see [Hugo installation guide] -- Hugo is installed via a package manager, e.g. *Homebrew* for macOS or *choco* for Windows.
|
||||||
|
|
||||||
|
|
|
@ -51,7 +51,7 @@ This project features the following content types (and subdirectories):
|
||||||
- `contributor`
|
- `contributor`
|
||||||
- `print`
|
- `print`
|
||||||
|
|
||||||
# Ontology
|
# Ontology {#ontology}
|
||||||
|
|
||||||
Sandpoints supports a triadic hierarchy. This follows that content is organized, or parented according to a tree structure with a depth of three (entities). This project follows the scheme `journal>issue>article` (other examples to visualize this content are `book>chapter>section`, and `ship>deck>room`).
|
Sandpoints supports a triadic hierarchy. This follows that content is organized, or parented according to a tree structure with a depth of three (entities). This project follows the scheme `journal>issue>article` (other examples to visualize this content are `book>chapter>section`, and `ship>deck>room`).
|
||||||
|
|
||||||
|
@ -102,13 +102,13 @@ For parenting and associating items see the , that lists all published content (all content that is not marked as draft).
|
*Sandpoints* projects feature a [sitemap](/), that lists all published content (all content that is not marked as draft).
|
||||||
The sitemap is at the root URL of any given project.
|
The sitemap is at the root URL of any given project.
|
||||||
|
|
||||||
# Backlinks
|
# Backlinks {#backlinks}
|
||||||
|
|
||||||
The concept of backlinks was described in early speculations that informed hypertext (i.e. by Vannevar Bush and later Ted Nelson), but were not implemented the WWW.
|
The concept of backlinks was described in early speculations that informed hypertext (i.e. by Vannevar Bush and later Ted Nelson), but were not implemented the WWW.
|
||||||
According to these ideas, hyperlinks are bi-directional, which follows that a hyperlink is visible both in the document that features a link *and also* at the target document where the link is pointing to. The latter aspect is a backlink. By this scheme, any document knows which other documents point to it.
|
According to these ideas, hyperlinks are bi-directional, which follows that a hyperlink is visible both in the document that features a link *and also* at the target document where the link is pointing to. The latter aspect is a backlink. By this scheme, any document knows which other documents point to it.
|
||||||
The same concept is used by search engine algorithms, such as 'page rank' by Google, that function by creating an index of how many webpages link to a specific target website -- or how many backlinks a given webpage has.
|
The same concept is used by search engine algorithms, such as 'page rank' by Google, that function by creating an index of how many webpages link to a specific target website -- or how many backlinks a given webpage has.
|
||||||
|
|
||||||
*Sandpoints* allows backlinks for selected items. These can be set at the config file, at the `sandpointsMentionedIn` array (see [Sandpoints config file](#sandpoints-config-file)).
|
*Sandpoints* allows backlinks for selected items. These can be set at the config file, at the `sandpointsMentionedIn` array (see [Sandpoints config file](#sandpoints-config)).
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -150,7 +150,7 @@ The root folder of the project contains the following files and folders.
|
||||||
| `PUBLISH.trigger.md` | git hook for automatically building the website upon certain commit messages
|
| `PUBLISH.trigger.md` | git hook for automatically building the website upon certain commit messages
|
||||||
| `readme.md` | standard Git repository readme file.
|
| `readme.md` | standard Git repository readme file.
|
||||||
|
|
||||||
# Sandpoints config file
|
# Sandpoints config file {#sandpoints-config}
|
||||||
|
|
||||||
Each Sandpoints project has a TOML config file at:
|
Each Sandpoints project has a TOML config file at:
|
||||||
```
|
```
|
||||||
|
|
|
@ -12,7 +12,7 @@ keywords:
|
||||||
# To-Do list
|
# To-Do list
|
||||||
|
|
||||||
1. [ ] Agree on and draft a mission statement.
|
1. [ ] Agree on and draft a mission statement.
|
||||||
2. [ ] Figure out editorial board (see [Potential editorial pool](#potential-editorial-pool)).
|
2. [ ] Figure out editorial board (see [Potential editorial pool](#ed-pool)).
|
||||||
3. [ ] Submissions
|
3. [ ] Submissions
|
||||||
1. [ ] Open to submissions anytime, or with open calls only?
|
1. [ ] Open to submissions anytime, or with open calls only?
|
||||||
2. [ ] Submission template.
|
2. [ ] Submission template.
|
||||||
|
@ -32,10 +32,10 @@ keywords:
|
||||||
10. [ ] Establish GitHub account for:
|
10. [ ] Establish GitHub account for:
|
||||||
1. sharing tools
|
1. sharing tools
|
||||||
2. forking repositories submitted as research
|
2. forking repositories submitted as research
|
||||||
11. Create a Zotero translator (almost ready; see [translator](#create-a-zotero-translator)).
|
11. Create a Zotero translator (almost ready; see [translator](#translator)).
|
||||||
|
|
||||||
|
|
||||||
# Potential editorial pool
|
# Potential editorial pool {#ed-pool}
|
||||||
- Stefano Gualeni
|
- Stefano Gualeni
|
||||||
- Konstantinos Dimopoulos (videogame urbanist, consultant, game designer, director and coordinator of the Game Design program at SAE Athens).
|
- Konstantinos Dimopoulos (videogame urbanist, consultant, game designer, director and coordinator of the Game Design program at SAE Athens).
|
||||||
- Eric Zimmerman
|
- Eric Zimmerman
|
||||||
|
@ -43,7 +43,7 @@ keywords:
|
||||||
|
|
||||||
# Other ToDos
|
# Other ToDos
|
||||||
|
|
||||||
## Create a Zotero Translator
|
## Create a Zotero Translator {#translator}
|
||||||
|
|
||||||
> Write a Zotero Translator to scrape reference metadata from entries of this site.
|
> Write a Zotero Translator to scrape reference metadata from entries of this site.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue