summaryrefslogtreecommitdiff
path: root/Paraboladocs
blob: 056581b0517189a21acb3fe41823c0c558b409c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
[[Category:ParabolaWiki]]
[[Category:Documentation]]

Paraboladocs, a distributed free documentation repository using Mediawiki markup. Documents are stored in a git repository. Currenty experimental.

== 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"

== Compare documents ==

=== git diff --word-diff ===

 diff

=== gvimdiff ===

 editdiff

=== Two web browser windows ===

Currently supports Iceweasel.

 compare

== Update from the remote repository ==

 git pull

== Update the remote repository ==

 git push