Kaldari has uploaded a new change for review. ( 
https://gerrit.wikimedia.org/r/390364 )

Change subject: Improving README.md for PageAssessments extension
......................................................................

Improving README.md for PageAssessments extension

Change-Id: Ib8c843cc6c7c66b162cef35cb2036ce1806149fd
---
M README.md
1 file changed, 4 insertions(+), 2 deletions(-)


  git pull 
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/PageAssessments 
refs/changes/64/390364/1

diff --git a/README.md b/README.md
index 70acf0f..223f6d2 100644
--- a/README.md
+++ b/README.md
@@ -3,9 +3,11 @@
 
 See https://www.mediawiki.org/wiki/Extension:PageAssessments for detailed 
documentation.
 
-This extension is for the purposes of storing article assessments as they 
happen in a new database table. This extension was designed keeping in mind 
Wikiprojects use-cases but it can be used for a number of other similar 
purposes.
+This extension is for the purposes of storing article assessments in a 
database table and providing an API for retrieving them. This extension was 
primarily designed to support WikiProjects, but it can be used for a number of 
other similar purposes.
 
-The parser function for invoking a new review is: {{#assessment: <Name of the 
wikiproject> | <Class> | <Importance>}}.
+The parser function for invoking a new review is: {{#assessment: <Name of the 
WikiProject> | <Class> | <Importance>}}. Typically this parser function will be 
embedded in an assessment template that is then transcluded on an article's 
talk page.
+
+If the extension is configured to support subprojects (see Configuration 
below), the subproject should follow the project name and be separated with a 
slash. For example, to record an assessment for the Crime task force of 
WikiProject Novels, you would use an assessment like: 
{{#assessment:Novels/Crime task force|B|Low}}
 
 Configuration
 -------------

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

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib8c843cc6c7c66b162cef35cb2036ce1806149fd
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/PageAssessments
Gerrit-Branch: master
Gerrit-Owner: Kaldari <[email protected]>

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

Reply via email to