Paraboladocs
Paraboladocs, a distributed free documentation repository using Mediawiki markup. Documents are stored in a git repository. Currenty experimental.
Contents
Get the repository
Git protocol, read-only
git clone git://projects.parabola.nu/paraboladocs.git
SSH access, read-write (permission required)
Parabola Hackers have access.
git clone git@projects.parabola.nu:parmanscripts.git
HTTPS access, read-only
git clone https://projects.parabola.nu/paraboladocs.git/
Prepare
The following uses "paraboladocs" script functions (https://projects.parabola.nu/parmanscripts.git/tree/paraboladocs).
The file "paraboladocs" must be sourced on the shell:
. path/to/paraboladocs
Equivalent:
source path/to/paraboladocs
It must be done on every shell session to use shell functions shown in other sections of this document.
Fetch documents from ParabolaWiki and ArchWiki
Example: Installation guide
load "Installation guide"
Show set titles
show
If the ArchWiki page has a different title
load_arch "Activating Numlock on Bootup (EspaƱol)"
Load wikipage converting to titlecase
load_arch -t "$title"
Only from ParabolaWiki
get parabola
Only from ArchWiki
get arch
Create a document
create
Using any editor
The document filename should be "$title" (shell variable "title").
Example
vim "$title"
Edit document
edit
The shell variable "title" can be used as shown above.
The wikipage can also be edited on ParabolaWiki. See Edit on ParabolaWiki.
Commit modifications
commit
Compare documents
git diff --word-diff
diff
gvimdiff
editdiff
Two web browser windows
Currently supports Iceweasel.
compare
Edit on ParabolaWiki
Opens the ParabolaWiki article in edit mode, in a web browser.
editwiki
Update from the remote repository
git pull
Update the remote repository
git push