pppadump/README.md

pppadump
=========


Bunch of scripts to extract documents from an [etherpad](http://etherpad.org/) instance and produce templated static files.

Forked from [constant](https://constantvzw.org/site/)'s [active archives](http://activearchives.org/wiki/Main_Page) [etherdump](https://gitlab.constantvzw.org/aa/etherdump) mixed with logic devised for [varia](https://varia.zone)'s [etherpump](https://git.vvvvvvaria.org/varia/etherpump) project



Requirements / dependencies
-------------
	* python3 / pip3
	* html5lib
	* requests
	* python-dateutil, 
	* jinja2

Installation
-------------

    pip3 install python-dateutil jinja2 html5lib
    python setup.py install

Usage
---------------
	mkdir mydump
	cd myddump
	pppadump init

The program then interactively asks some questions:

	Please type the URL of the etherpad: 
		http://automatist.local:9001/
	The APIKEY is the contents of the file APIKEY.txt in the etherpad folder
	Please paste the APIKEY: 
		xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

The settings are placed in a file called .pppadump/settings.json and are used (by default) by future commands.


	pppadump list

You should see a list of pads.


subcommands
----------

* init
* pull
* list
* listauthors
* gettext
* settext
* gethtml
* creatediffhtml
* revisionscount
* index
* deletepad
* pushhtml

To get help on a subcommand:

	pppadump revisionscount --help


Magicwords
=================
Following the suggestions of sister project/friendly fork [etherpump](https://git.vvvvvvaria.org/varia/etherpump/), the magic word mechanism has been expanded (from the inital single hard coded \_\_NOPUBLISH__ value) to and generalized to allow a the use of text markers in the source text to control various options, including options for use in preprocessing and translation of markdown using pandoc.


Originally designed for use at: [constant](http://etherdump.constantvzw.org/).