Welcome to the deployment guide for Scribe

Scribe has been conceived to add functionality to the Visual Editor of Mediawiki as a gadget and so if you have any experiences with activating and using gadgets you should be smiling at the moment.

How to set up

edit

Note: This setup assumes that VisualEditor and it’s dependencies have been installed on the Concerned Wiki

The following setup is required to get Scribe up and running:

  • Copy the content of the gadget css found here to the MediaWiki:Gadget-scribe.css page on your wiki.
  • Copy the gadget Javascript found here to the MediaWiki:Gadget-scribe.js page on your wiki instance
  • Add the following definition code to MediaWiki:Gadgets-definition page on your wiki instance
* scribe[ResourceLoader|dependencies=ext.visualEditor.core|mediawiki|mediawiki.api]|scribe.js|scribe.css
  • Edit the message strings at the top of the Javascript file( MediaWiki:Gadget-scribe.js in this case ) by replacing the message strings with the translations in your language of preference as shown in the example  below:
've-scribe-add-reference-label': 'ADD',

've-scribe-add-reference-again-label': 'ADD AGAIN',

've-scribe-dialog-title': 'Scribe',

've-scribe-editing-ideas-txt': 'Editing Ideas?',

've-scribe-launch-prompt-msg': 'Edit in Scribe Mode?',

've-scribe-launch-scribe-accept': 'Yes',

've-scribe-launch-scribe-deny': 'No',

've-scribe-new-section-txt': 'New Section?', 've-scribe-server-error': 'Unable to Reach Server Right now',

've-scribe-suggested-sestion-txt': 'Suggested Sections',

've-scribe-search-score-label': 'Search score',

've-scribe-wikipedia-label': 'Wikipedia',

've-scribe-wikipedia-domain-label': 'Wikipedia domain'

've-scribe-add-reference-label': ‘XXXX’,

've-scribe-add-reference-again-label': 'XXXX',

've-scribe-dialog-title': 'Scribe',

've-scribe-editing-ideas-txt': 'XXXXXXX?',

've-scribe-launch-prompt-msg': 'XXXXXXX?',

've-scribe-launch-scribe-accept': 'XXXX',

've-scribe-launch-scribe-deny': 'XXX',

've-scribe-new-section-txt': 'XXXXX?', 've-scribe-server-error': 'XXXXXXXX',

've-scribe-suggested-sestion-txt': 'XXXXXXX'

've-scribe-search-score-label': 'XXXXXXX,

've-scribe-wikipedia-label': ‘XXXXXX’, 've-scribe-wikipedia-domain-label': 'XXXXXXX'

Where ‘XXXXXX’ represents the translation of the original English word in the language of your chosen Wiki.

  • Navigate to Preferences/Gadgets and activate ⧼gadget-scribe⧽ by checking the box beside the gadget label.

This should activate the Scribe gadget on the Wiki.

Try creating any article which does not exist from a red link and you should be prompted to use scribe to create the new article.

You can also watch this video on how to use the Scribe gadget.