Skip to content

Commit 5c1ecc4

Browse files
paulobapauloba
committed
Minor changes - documentation
1 parent f73252e commit 5c1ecc4

File tree

5 files changed

+204
-31
lines changed

5 files changed

+204
-31
lines changed

‎docs/LatchExtension.txt‎

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
install.txt
1+
LatchExtension.txt
22
/**
33
* Plugin Name: latch
44
* Plugin URI: http://www.elevenpaths.com
@@ -14,18 +14,58 @@ install.txt
1414
|_______________________________________________________________________________________|/
1515

1616

17+
_________________________________________________________________________________
18+
| |
19+
| INDEX |
20+
| |
21+
| [1] Installation using the script install.sh (Only with MySQL DataBase) |
22+
| [1.1] Running the install.sh script |
23+
| [1.2] Application ID & secret settings |
24+
| |
25+
| [2] Installing the extension manually |
26+
| [2.1] Install the logic of the plugin |
27+
| [2.2] Install the PHP SDK |
28+
| [2.3] Install the language support |
29+
| [2.4] Append includes in LocalSettings |
30+
| [2.5] Create a table in the database |
31+
| [2.6] Settings: application ID & secret |
32+
| [2.7] IMPORTANT |
33+
| |
34+
| [3] Uninstallation using the script uninstall.sh (Only with MySQL DataBase) |
35+
| |
36+
| [4] Uninstalling the extension manually |
37+
| [4.1] Quick uninstall |
38+
| [4.2] Uninstall |
39+
| |
40+
| [5] What are this files for? |
41+
| |
42+
| [6] Special thanks |
43+
|_______________________________________________________________________________|
1744

1845
===================================================================================================
1946
[1] Installing the extension using the script install.sh ~ ONLY IF YOU ARE USING A MySQL DataBase ~
2047
===================================================================================================
2148

49+
-----------------------------------------------------------------------------------
50+
[1.1] Running the install.sh script
51+
-----------------------------------------------------------------------------------
2252
~ Login as root user in your terminal and then follow the instructions as follows:
2353
Make sure you have rsync installed, if not, install it:
2454
apt-get install rsync (debian/ubuntu), yum install rsync (fedora) ...
2555
Set permissions for the script by typing
2656
chmod 777 install.sh
2757
Execute the script install.sh typing
2858
./install.sh
59+
60+
-----------------------------------------------------------------------------------
61+
[1.2] Application ID & secret settings
62+
-----------------------------------------------------------------------------------
63+
To get an application ID and application secret go to the developer area
64+
at https://latch.elevenpaths.com and sign up to create a developer account.
65+
66+
Then go to your settings add a new application named Mediwiki (or whatever
67+
you want) and copy/paste the appId and the secret from the web into the
68+
file /usr/share/mediawiki/extensions/Latch/LatchConfig.php
2969

3070
***********************************************************************************************
3171
*** Be aware that if your mediawiki installation is not located under /usr/share/mediawiki ****
@@ -125,7 +165,17 @@ Also copy the file LatchExtension.txt under /usr/share/mediawiki/docs
125165
EXIT;
126166

127167
-----------------------------------------------------------------------------------
128-
[2.6] IMPORTANT
168+
[2.6] Settings: application ID & secret
169+
-----------------------------------------------------------------------------------
170+
To get an application ID and application secret go to the developer area
171+
at https://latch.elevenpaths.com and sign up to create a developer account.
172+
173+
Then go to your settings add a new application named Mediwiki (or whatever
174+
you want) and copy/paste the appId and the secret from the web into the
175+
file /usr/share/mediawiki/extensions/Latch/LatchConfig.php
176+
177+
-----------------------------------------------------------------------------------
178+
[2.7] IMPORTANT
129179
-----------------------------------------------------------------------------------
130180
Be aware that all this files need at least 744 permissions
131181
(user:rwx, group:r, others:r)

‎linux_install/install.sh‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ chmod -R 744 /usr/share/mediawiki/docs
4545

4646
#CREATE THE LATCH TABLE INTO THE MEDIAWIKI DATABASE
4747
echo "*****************************************************************************************************"
48+
echo "*****************************************************************************************************"
4849
echo "Find the file LocalSettings.php under /usr/share/mediawiki and find the section Database settings"
4950
echo -n "Enter the server name: "
5051
read DBserverName
@@ -59,7 +60,15 @@ SELECT COUNT(*) FROM information_schema.tables WHERE table_name = 'latch';
5960
DESCRIBE latch;
6061
EOF
6162
echo "*****************************************************************************************************"
63+
echo "*****************************************************************************************************"
6264
echo "If you see the description of the table in the line above this, the table was created successfully."
63-
echo "Otherwise please create the table manually."
64-
echo "Read install.txt section [2.5] for further details."
65-
echo "Be aware that this installation script only works if your Mediawiki database is MySQL."
65+
echo "Otherwise please create the table manually. Read linux_install.txt section [2.5]"
66+
echo ""
67+
echo ":::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::"
68+
echo ":::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::"
69+
echo " Warning! ~ Achtung! ~ Uwaga! ~ Tähelepanu! ~ Atenție! ~ Pozor! ~ Atenção! ~ Dikkat! ~ Huomio! ~ Attenzione! "
70+
echo ":::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::"
71+
echo ":::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::"
72+
echo "Now you need to get an application ID and application secret."
73+
echo "Go to the developer area at https://latch.elevenpaths.com to get them."
74+
echo "Copy&paste the appId and the secret from the web into the file LatchConfig.php"

‎linux_install/linux_install.txt‎

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
install.txt
1+
linux_install.txt
22
/**
33
* Plugin Name: latch
44
* Plugin URI: http://www.elevenpaths.com
@@ -14,18 +14,58 @@ install.txt
1414
|_______________________________________________________________________________________|/
1515

1616

17+
_________________________________________________________________________________
18+
| |
19+
| INDEX |
20+
| |
21+
| [1] Installation using the script install.sh (Only with MySQL DataBase) |
22+
| [1.1] Running the install.sh script |
23+
| [1.2] Application ID & secret settings |
24+
| |
25+
| [2] Installing the extension manually |
26+
| [2.1] Install the logic of the plugin |
27+
| [2.2] Install the PHP SDK |
28+
| [2.3] Install the language support |
29+
| [2.4] Append includes in LocalSettings |
30+
| [2.5] Create a table in the database |
31+
| [2.6] Settings: application ID & secret |
32+
| [2.7] IMPORTANT |
33+
| |
34+
| [3] Uninstallation using the script uninstall.sh (Only with MySQL DataBase) |
35+
| |
36+
| [4] Uninstalling the extension manually |
37+
| [4.1] Quick uninstall |
38+
| [4.2] Uninstall |
39+
| |
40+
| [5] What are this files for? |
41+
| |
42+
| [6] Special thanks |
43+
|_______________________________________________________________________________|
1744

1845
===================================================================================================
1946
[1] Installing the extension using the script install.sh ~ ONLY IF YOU ARE USING A MySQL DataBase ~
2047
===================================================================================================
2148

49+
-----------------------------------------------------------------------------------
50+
[1.1] Running the install.sh script
51+
-----------------------------------------------------------------------------------
2252
~ Login as root user in your terminal and then follow the instructions as follows:
2353
Make sure you have rsync installed, if not, install it:
2454
apt-get install rsync (debian/ubuntu), yum install rsync (fedora) ...
2555
Set permissions for the script by typing
2656
chmod 777 install.sh
2757
Execute the script install.sh typing
2858
./install.sh
59+
60+
-----------------------------------------------------------------------------------
61+
[1.2] Application ID & secret settings
62+
-----------------------------------------------------------------------------------
63+
To get an application ID and application secret go to the developer area
64+
at https://latch.elevenpaths.com and sign up to create a developer account.
65+
66+
Then go to your settings add a new application named Mediwiki (or whatever
67+
you want) and copy/paste the appId and the secret from the web into the
68+
file /usr/share/mediawiki/extensions/Latch/LatchConfig.php
2969

3070
***********************************************************************************************
3171
*** Be aware that if your mediawiki installation is not located under /usr/share/mediawiki ****
@@ -125,7 +165,17 @@ Also copy the file LatchExtension.txt under /usr/share/mediawiki/docs
125165
EXIT;
126166

127167
-----------------------------------------------------------------------------------
128-
[2.6] IMPORTANT
168+
[2.6] Settings: application ID & secret
169+
-----------------------------------------------------------------------------------
170+
To get an application ID and application secret go to the developer area
171+
at https://latch.elevenpaths.com and sign up to create a developer account.
172+
173+
Then go to your settings add a new application named Mediwiki (or whatever
174+
you want) and copy/paste the appId and the secret from the web into the
175+
file /usr/share/mediawiki/extensions/Latch/LatchConfig.php
176+
177+
-----------------------------------------------------------------------------------
178+
[2.7] IMPORTANT
129179
-----------------------------------------------------------------------------------
130180
Be aware that all this files need at least 744 permissions
131181
(user:rwx, group:r, others:r)

‎windows_install/LatchExtension.txt‎

Lines changed: 44 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
install.txt
1+
LatchExtension.txt
22
/**
33
* Plugin Name: latch
44
* Plugin URI: http://www.elevenpaths.com
@@ -15,6 +15,28 @@ install.txt
1515

1616
I am working on a Windows installer, by now, you will have to install the extension manually.
1717

18+
_________________________________________________________________________________
19+
| |
20+
| INDEX |
21+
| |
22+
| [1] Installing the extension manually |
23+
| [1.1] Install the logic of the plugin |
24+
| [1.2] Install the PHP SDK |
25+
| [1.3] Install the language support |
26+
| [1.4] Append includes in LocalSettings |
27+
| [1.5] Create a table in the database |
28+
| [1.6] Settings: application ID & secret |
29+
| [1.7] IMPORTANT |
30+
| |
31+
| [2] Uninstalling the extension manually |
32+
| [2.1] Quick uninstall |
33+
| [2.2] Uninstall |
34+
| |
35+
| [3] What are this files for? |
36+
| |
37+
| [4] Special thanks |
38+
|_______________________________________________________________________________|
39+
1840

1941
===================================================================================================
2042
[1] Installing the extension manually
@@ -23,7 +45,7 @@ I am working on a Windows installer, by now, you will have to install the extens
2345
~ Follow the instructions as follows:
2446

2547
-----------------------------------------------------------------------------------
26-
[2.1] Install the logic of the plugin
48+
[1.1] Install the logic of the plugin
2749
-----------------------------------------------------------------------------------
2850
To make the extension work it is needed to create a directory named latch,
2951
under C:\xampp\apps\mediawiki\htdocs\extensions
@@ -36,15 +58,15 @@ and copy the following files there:
3658
LatchConfig.php
3759

3860
-----------------------------------------------------------------------------------
39-
[2.2] Install the PHP SDK
61+
[1.2] Install the PHP SDK
4062
-----------------------------------------------------------------------------------
4163
Create a directory PHP_SDK under C:\xampp\apps\mediawiki\htdocs\extensions\Latch and copy the files:
4264
Latch.php
4365
LatchResponse.php
4466
Error.php
4567

4668
-----------------------------------------------------------------------------------
47-
[2.3] Install the language support
69+
[1.3] Install the language support
4870
-----------------------------------------------------------------------------------
4971
For language support into Catalan, English, Spanish, Basque, Galician, Polish, Turkish and German
5072
create a directory named i18n under C:\xampp\apps\mediawiki\htdocs\extensions\Latch and copy the files:
@@ -57,7 +79,7 @@ and copy the following files there:
5779
tr.json
5880

5981
-----------------------------------------------------------------------------------
60-
[2.4] Append includes in LocalSettings
82+
[1.4] Append includes in LocalSettings
6183
-----------------------------------------------------------------------------------
6284
You need to alter the file LocalSettings.php.
6385
Be aware to do this after including the extension.
@@ -76,7 +98,7 @@ and copy the following files there:
7698
require_once 'C:\xampp\apps\mediawiki\htdocs\extensions\Latch\PHP_SDK\Error.php';
7799

78100
-----------------------------------------------------------------------------------
79-
[2.5] Create a table in the database
101+
[1.5] Create a table in the database
80102
-----------------------------------------------------------------------------------
81103
The last step is to create a table in your local Mediawiki database.
82104
You can check the file C:\xampp\apps\mediawiki\LocalSettings.php
@@ -100,25 +122,35 @@ and copy the following files there:
100122
CREATE INDEX mw_user_id ON latch(mw_user_id);
101123
EXIT;
102124
shell> "C:\Program Files\MySQL\MySQL Server 5.0\bin\mysqladmin" -u root shutdown
125+
126+
-----------------------------------------------------------------------------------
127+
[1.6] Settings: application ID & secret
128+
-----------------------------------------------------------------------------------
129+
To get an application ID and application secret go to the developer area
130+
at https://latch.elevenpaths.com and sign up to create a developer account.
131+
132+
Then go to your settings add a new application named Mediwiki (or whatever
133+
you want) and copy/paste the appId and the secret from the web into the
134+
file LatchConfig.php
103135

104136
-----------------------------------------------------------------------------------
105-
[2.6] IMPORTANT
137+
[1.7] IMPORTANT
106138
-----------------------------------------------------------------------------------
107139
Be aware that all this files need at least read write and execute permissions .
108140
So to make sure all this works, chech that all the files copied have the right permissions.
109141

110142

111143
===================================================================================================
112-
[3] Uninstalling the extension
144+
[2] Uninstalling the extension
113145
===================================================================================================
114146

115147
-----------------------------------------------------------------------------------
116-
[3.1] Quick uninstall
148+
[2.1] Quick uninstall
117149
-----------------------------------------------------------------------------------
118150
For a quick uninstall of the extension just remove the includes added in the LocalSettings.php
119151

120152
-----------------------------------------------------------------------------------
121-
[3.2] Uninstall
153+
[2.2] Uninstall
122154
-----------------------------------------------------------------------------------
123155
- For a more carefull uninstall remove the files under C:\xampp\apps\mediawiki\htdocs\extensions\Latch
124156

@@ -130,7 +162,7 @@ and copy the following files there:
130162

131163

132164
===================================================================================================
133-
[4] What are this files for?
165+
[3] What are this files for?
134166
===================================================================================================
135167

136168
The file LatchAccount.php includes the code to add a section in the user's preferences,
@@ -154,7 +186,7 @@ The file LatchConfig.php contains settings needed to send queries to the Latch s
154186

155187

156188
===================================================================================================
157-
[5] Special thanks
189+
[4] Special thanks
158190
===================================================================================================
159191

160192
As a Spaniard myself I took the time to translate the Latch extension into Spanish and Galician.

0 commit comments

Comments
 (0)