summaryrefslogtreecommitdiff
path: root/Paraboladocs
diff options
context:
space:
mode:
Diffstat (limited to 'Paraboladocs')
-rw-r--r--Paraboladocs84
1 files changed, 73 insertions, 11 deletions
diff --git a/Paraboladocs b/Paraboladocs
index ca3e7f2..056581b 100644
--- a/Paraboladocs
+++ b/Paraboladocs
@@ -7,28 +7,90 @@ Paraboladocs, a distributed free documentation repository using Mediawiki markup
=== Git protocol, read-only ===
- git clone git://alfplayer.me/paraboladocs.git
+ git clone git://projects.parabola.nu/paraboladocs.git
=== SSH access, read-write (permission required) ===
-Parabola Hackers have access. Others can ask ''alfplayer <alfplayer@mailoo.org>'' to get access without restrictions.
+Parabola Hackers have access.
- git clone git@alfplayer.me:freedocs.git
+ git clone git@projects.parabola.nu:parmanscripts.git
-=== HTTP access, read-only ===
+=== HTTPS access, read-only ===
- http://alfplayer.me/project/freedocs
+ git clone https://projects.parabola.nu/paraboladocs.git/
-== Fetch documents from ArchWiki and ParabolaWiki ==
+== 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
- title="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"
+
+== Compare documents ==
+
+=== git diff --word-diff ===
+
+ diff
+
+=== gvimdiff ===
+
+ editdiff
+
+=== Two web browser windows ===
+
+Currently supports Iceweasel.
+
+ compare
-=== From ArchWiki ===
+== Update from the remote repository ==
- curl "https://wiki.archlinux.org/index.php?title=$title&action=raw" > "$title"
+ git pull
-=== From ParabolaWiki ===
+== Update the remote repository ==
- curl "https://wiki.parabola.nu/index.php?title=Installation_Guide&action=raw" > "$title"
+ git push