1. Creating new content via the online Sandpoints preview site¶
Sandpoints provides a preview page that allows for both creating new entries and also editing existing entries via a browser, without the requirement of a local clone of the project. Any action will open a new tab at the project repository page, and requires the user to be logged in to the project repository.
To access the preview page append /_preview/ to the ⁄sitemap URL.
Notes:
- Creating new items via the preview site does not make use of archetypes. Any new item created with this workflow will result in an empty Markdown file (Screenshot 3), and will require a YAML header to work.
- Therefore, when creating new content via the preview site, it is strongly recommended to copy the contents of the corresponding archetype. See archetype templates at §⁄Table 1, which include instructions as well as a sample YAML header to copy and fill in.
- At the moment the interface for creating and editing files does not provide a preview of the Markdown documents.
2. Filename conventions and instructions for creating new entries¶
File naming:
- All lowercase
- Use dash as separator
- No spaces
- No underscores
Examples and instructions per entry type:
| Type | Filename convention | Instructions template |
|---|---|---|
| contributor | name-surname.md | article⁄New contributor archetype |
| editor | name-surname.md | article⁄New editor archetype |
| issue (x is number) | issue-x.md | article⁄New issue archetype |
| article | article-short-title.md | article⁄New article archetype |
| p-issue-x.md | article⁄New print archetype |
3. Steps for creating new content¶
- Create a new file, named according to §⁄file naming conventions.
- Open the new file, and copy the YAML sample and instructions corresponding to the content type of the new file (Table 1)
- Fill in the metadata fields:
- add your name in the
authorfield - edit header information (title, keywords, abstract, etc.)
- add your name in the
- Edit content.
- Commit changes via Git when necessary.
- When editing is done and the new entry is ready for publishing, change
draft: truetodraft: false. - Commit changes via Git.
- To recompile the site and include these changes include the keyword
!publish!in your commit message.
4. Preview site interface¶
The preview site features a toolbar with five options (Screenshot 1), explained in the table below.
| Preview site options | |
|---|---|
| EDIT_THIS | edit the current page |
| ADD_JOURNAL / ADD_ISSUE / ADD_ARTICLE | create new entry by type |
| PUBLISH | recompile the website to include any unpublished changes |
| ? | open the repository website |
5. Editing & new item creation¶
All modifications (edits or new items) are carried out as git commits (Screenshots 2 and 3).
