Addshore has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/316780

Change subject: Update README
......................................................................

Update README

Change-Id: I90c6e14f23e013e904fb25597c45cb364bb944e1
---
M README.md
M extension.json
2 files changed, 17 insertions(+), 12 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Cognate 
refs/changes/80/316780/1

diff --git a/README.md b/README.md
index de66f04..1e0a1b3 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,13 @@
 # Cognate extension
 
-This MediaWiki extension creates a central store where the page titles of all 
translations for a page are stored. 
-The extension can then generate translation links across wiki projects. 
+This MediaWiki extension creates a central store where the page titles for a 
group of sites are stored.
+The extension can then generate interwiki links across wiki projects in cases 
where the titles are the same.
 
 It works on the assumption that (most) page titles are the same across 
languages, as it is the case for the Wiktionary 
-projects. Some research still has to be done to what extent the page titles 
differ according to project/language-specific
+projects.
+Some research still has to be done to what extent the page titles differ 
according to project/language-specific
 spelling rules.
+Some normalization is already applied to titles.
 
 This extension is an attempt to solve the task
 "[Centralize interwiki language links for 
Wiktionary](https://phabricator.wikimedia.org/T987)"
@@ -13,6 +15,8 @@
 "Cognate" is a linguistic concept, meaning same words in different languages 
developed from the same origin. 
 Since this extension has a similar translation mechanism, it makes for a nice 
short extension name, even when the 
 actual concept is different.
+
+This extension can be used along side the [InterwikiSorting 
extension](https://www.mediawiki.org/wiki/Extension:InterwikiSorting) to sort 
the interwiki links that are output.
 
 ## Installation
 ### Single-Wiki setup
@@ -23,15 +27,15 @@
 
 Now call the `maintenance/update.php` script from the command line to set up 
the new database table of the extension.
 
-You can now run the unit tests and check if saving pages writes their titles 
to the database table. No translation links will be generated, except if you 
add manual entries to the database table. 
+You can now run the unit tests and check if saving pages writes their titles 
to the database table.
+No translation links will be generated, except if you add manual entries to 
the database table.
 
 ### Multiple language setup
 For the multiple language setup (that reflects the state of the Wiktionary 
projects), you need have several MediaWiki installations in different languages 
that act as the different Wiktionary projects. You need to set up the load 
balancer configurations with wiki names for each project. One of the wikis will 
be the "main wiki" that contains the "central store" database table, set up as 
above. You need to add a line like this to the `LocalSettings.php` of all the 
other Wikis:
 
-    $wgCognateWiki = 'enwiktionary'
- 
-Replace `enwiktionary` with the load balancer wiki name of of the main wiki.
- 
-## Known Issues
-This extension is by no means finished and just a suggestion on how the task 
T987 might be tackled. There are lots of 
-TODOs in the code and in the task comments.  
+    $wgCognateDb = 'wiktionary'
+    $wgCognateCluster = 'extension1'
+    $wgCognateGroup = 'wiktionary'
+
+Both the DB and the Cluster are configurable.
+The Group is currently used to transform the stored language into a dbname. It 
might make more sense to do this in a different way.
diff --git a/extension.json b/extension.json
index 088cc69..1f8ba6e 100644
--- a/extension.json
+++ b/extension.json
@@ -2,7 +2,8 @@
   "name": "Cognate",
   "version": "0.0.1",
   "author": [
-    "Gabriel Birke <[email protected]>"
+    "Gabriel Birke <[email protected]>",
+    "Addshore"
   ],
   "url": "https://www.mediawiki.org/wiki/Extension:Cognate";,
   "descriptionmsg": "cognate-desc",

-- 
To view, visit https://gerrit.wikimedia.org/r/316780
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I90c6e14f23e013e904fb25597c45cb364bb944e1
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Cognate
Gerrit-Branch: master
Gerrit-Owner: Addshore <[email protected]>

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to