CC/octomode
12
0
Fork 0
Code Issues 18 Pull Requests Projects Releases Wiki Activity

'README.md' updaten

Browse Source
This commit is contained in:
mb 2023-11-10 16:45:30 +01:00
parent e821212043
commit 8bfad89fd3
1 changed files with 1 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -10,38 +10,6 @@ More expanded documentation can be found here: <https://cc.vvvvvvaria.org/wiki/O
An installation guide can be found below.
## How to use octomode?
If you want to work collectively on making a PDF, you can use octomode. There is an instance installed here: <https://octomode.vvvvvvaria.org/>. You can write any name of in the input field, this will create a new octomode environment.
Working in octomode includes:
* `pad`: all materials for the PDF are collected here. (written in Markdown)
* `stylesheet`: all CSS rules for the PDF are collected here (written in CSS)
* `html`: render the lay out as a HTML (rendered with PyPandoc)
* `pdf`: render the lay out as a PDF (rendered with Paged.js)
When creating a new environment, a few things happen:
* a pad is created for collecting the materials of your PDF. The name of the octomode environment will become the name of this pad. For example: `http://pad.vvvvvvaria.org/NAME.md`.
* another pad is created for writing the stylesheet of your PDF. The name of the octomode environment will become the name of this pad, followed by .css. For example: `https://pad.vvvvvvaria.org/NAME.css`
* If both pads were not created yet, a template is added to the pad. The main pad will get a Markdown template and the stylesheet pad a CSS template.
In case a pad was already made, you can copy the templates below and paste them at the top of your pads.
The PDFs are rendered using [Paged.js](https://pagedjs.org/), a free and open source JavaScript library "that paginates content in the browser to create PDF output from any HTML content. This means you can design works for print (eg. books) using HTML and CSS!" The project is maintained by the [Coko Foundation](https://coko.foundation/). Paged.js adds not (yet) implemented CSS rules to the ones that browsers implemented already, expanding the possibilities to make lay outs for specific sections, place content in the margins of pages, and render indexes (amongst other things). The Paged.js documentation is very helpful and can be found here: <https://pagedjs.org/documentation/>.
## Continuums
Octomode resonates other software practices based on pad-to-PDF workflows or collective infrastructure, including:
* ethertoff http://osp.kitchen/tools/ethertoff/ by OSP
* ether2html http://osp.kitchen/tools/ether2html/ by OSP
* etherpash https://freeze.sh/_/2015/conversations/#mdsh by Freeze/Christoph Haag
* etherbox https://networksofonesown.constantvzw.org/ by Michael Murtaugh/Constant
* etherdump https://gitlab.constantvzw.org/aa/etherdump by Michael Murtaugh/Constant
* pad2print https://gitlab.com/Luuse/pad2print by Luuse
## Install octomode
You can clone this repository to run octomode on your own computer or server.
@ -109,11 +77,4 @@ You can simply run *octomode* now with the following command to run it with `gun
## Use octomode locally
It's recommended to use Firefox when working with octomode locally. Chrome or Chromium do not load external etherpads in iframes.
## Snapshots
![](snapshots/breakybreaky-in-octomode-1.png)
![](snapshots/breakybreaky-in-octomode-2.png)
![](snapshots/breakybreaky-in-octomode-3.png)
![](snapshots/breakybreaky-in-octomode-5.png)
It's recommended to use Firefox when working with octomode locally. Chrome or Chromium do not load external etherpads in iframes.