Paraboladocs
Paraboladocs, a distributed free documentation repository using Mediawiki markup. Documents are stored in a git repository. Currenty experimental.
Contents
1 Get the repository
1.1 Git protocol, read-only
git clone git://projects.parabola.nu/paraboladocs.git
1.2 SSH access, read-write (permission required)
Parabola Hackers have access.
git clone git@projects.parabola.nu:parmanscripts.git
1.3 HTTPS access, read-only
git clone https://projects.parabola.nu/paraboladocs.git/
2 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.
3 Fetch documents from ParabolaWiki and ArchWiki
Example: Installation guide
load "Installation guide"
3.1 Show set titles
show
3.2 If the ArchWiki page has a different title
load_arch "Activating Numlock on Bootup (Español)"
3.2.1 Load wikipage converting to titlecase
load_arch -t "$title"
3.3 Only from ParabolaWiki
get parabola
3.4 Only from ArchWiki
get arch
4 Create a document
create
4.1 Using any editor
The document filename should be "$title" (shell variable "title").
4.1.1 Example
vim "$title"
5 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.
6 Commit modifications
commit
7 Compare documents
7.1 git diff --word-diff
diff
7.2 gvimdiff
editdiff
7.3 Two web browser windows
Currently supports Iceweasel.
compare
8 Edit on ParabolaWiki
Opens the ParabolaWiki article in edit mode, in a web browser.
editwiki
9 Update from the remote repository
git pull
10 Update the remote repository
git push