MoodleDocs - User contributions [en]

Global search

2019-10-23T18:38:12Z

Dschwa: Added a SQL query fix for a common error

{{More features}}
==What is Global search?==
*Global search lets you search everywhere on the Moodle site that you have access to. A student can search their courses for particular lecture notes, for example, or a teacher could search for subject-related activities.
*The feature needs to be enabled by the administrator in Advanced features and then, from the Manage Global search page, the search engine must be selected.

When Global search is enabled, search box is then available next to the user menu.

[[File:NFGlobalsearchbox.png|thumb|center|480px|Searching the site (when global search is enabled)]]

*A [[Global search block]] may also be added to course pages.

==What can I search for?==
You can search for your courses, activities information and some activities contents like forum posts, book chapters, glossary entries or collaborative wikis pages.

HTML block content may be searched and, if the administrator sets the setting "Searchable courses" to ''Search within all courses the user can access'' then courses which are visible to users but which they are not enrolled in may also be searched. (These courses are courses with guest access or if the user has the capability to view all courses.)

==How does it work?==
*Click the search icon by the user menu and type a search term into the box that appears, or type into the box in the [[Global search block]] if enabled.
*On the next screen, you can simply click the search button to search everywhere, or expand the Filter to search in specific areas:

[[File:NFFilteringGlobalSearch2.png|thumb|center|600px|Filtering the search]]

*You will then see results displayed from all areas of Moodle you have access to:

[[File:31GSResults2a.png|thumb|center|600px|Search results]]

===Solr-specific features===
''These features are only available if you use '''Solr''' as your search engine.''

====Search query features====
You can improve your search using any of the following search query features:

* Specifying the field to be searched by prefixing the search query with 'title:', 'content:', 'name:', or 'intro:' e.g.'title:news' returns results with the word 'news' in the title
* Boolean operators ('AND', 'OR', 'NOT') to combine or exclude keywords
* Wildcard characters ('*' or '?' ) to represent characters in the search query
* Proximity searches ('~') e.g. mood~2 returns "moodle" (2 letters away from "mood"), Moodle Australia~3 returns results containing "Moodle HQ in Perth, Australia" (the queried terms were within 3 words of each other)
* Boosting terms ('^') to boost certain words or phrases e.g. "Perth Australia"^5 "Australia" will return results with the phrase "Perth Australia" as more relevant.

====File contents indexing====
Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts.

====Extra filters====
'''New in 3.5''' : New fields now facilitate filtering by user ID and searching by group.

==How is it set up?==

Note: Global search needs a search engine. It's recommended you set everything up first, index the site contents ''and only then'' enable Global search.

Moodle core includes two search engines: Simple Global search and Solr. See the [https://docs.moodle.org/dev/Search_engines Developer docs on Search engine plugins] if you wish to write your own.

===Setting up Simple search===

Simple Global search provides global search features without the need to install an external search engine.

{{MediaPlayer | url = https://youtu.be/4JJhOd2XAiY | desc = Simple global search}}

===Setting up Solr===

* The latest Solr 5 available version is the recommended one.
* Moodle supports Solr server from 4.0 onwards, although you can only use the Solr schema setup script that we provide with Moodle from Solr 5. The latest Solr 5 available version is the recommended one; the same will apply to Solr 6 once it is released.

====General Setup====

# Set the feature up in ''Site administration > Plugins > Search > Manage global search'' by selecting Solr as the search engine and ticking search area checkboxes as required
# In ''Site administration > Plugins > Search > Solr'', set '''Host name''' to localhost, '''Port''' to 8983 and '''Index name''' to 'moodle' (the name of the index in Solr)
# If you are using Solr with SSL encryption and basic authentication (see below if you want to use client certificates instead), you will need to configure this.This is important if solr is not installed in the web server server.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## Set port number if required (sometimes SSL installations use port 443).
## Type in the username and password.
# If you are using Solr with SSL encryption via client certificates, you will need to configure Moodle as such. This is important if solr is not installed in the web server server.
## You will need a separate key file and cacert file, both in pem format, located on your server Moodle, and readable by the PHP process.
## Go to ''Site administration > Plugins > Search > Solr''
## Set '''Secure mode''' to Yes
## '''SSL certificate''' to /path/to/certs/solr-ssl.cacert.pem
## '''SSL key''' to /path/to/certs/solr-ssl.key.pem
## '''SSL key Password''' to The password used to lock the SSL Key
## '''SSL CA certificates name''' to /path/to/certs/solr-ssl.cacert.pem
# You now need to populate the created Solr index with your site's data. You can do it via the web interface by going to ''Site administration > Reports > Global search info'' or from the CLI by running the <tt>search/cli/indexer.php</tt> script. The CLI script is the recommended option for big sites. <code># sudo -u www-run php search/cli/indexer.php --force</code>
# Enable Global search in ''Site administration > Advanced features''

====File Indexing====

Solr has the ability to index the contents of files, such as File resources and attachments to Forum posts. This uses the [https://tika.apache.org/ Tika] engine which comes bundled with Solr. To enable this feature:
# In ''Site administration > Plugins > Search > Solr'' enable the checkbox '''Enable file indexing'''
# Set '''Maximum file size to index (kB)''' to some value - the default is '''2097152''' (2GB)
#* Files larger than this limit will not be sent for Solr for indexing, but the file name will still be indexed.

'''New in 34:''' File indexing now works retroactively -ie, if you set up Global search without file indexing enabled and a later date you enable file indexing, files associated with existing objects will be included.

====How to install Solr====

You need PHP Solr extension installed. You can download the official latest versions from [http://pecl.php.net/package/solr PECL: Package: solr]. The minimum required version is PECL Solr 2.1 for PHP 5 branch and PECL Solr 2.4 for PHP 7 branch.

Basic installation steps (using apache web server):

===== Linux (Debian/Ubuntu) =====
Using APT:
sudo apt install php-solr
sudo service apache2 restart

If you can't install the SOLR PHP module via APT, try the following:

With PHP5.x
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php5-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php5/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php5/cli/conf.d/solr.ini"
sudo service apache2 restart

With PHP 7
sudo apt-get install libpcre3-dev libxml2-dev libcurl4-openssl-dev
sudo apt-get install php7.0-dev
sudo apt-get install php-pear
sudo pecl install solr
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/apache2/conf.d/solr.ini"
sudo sh -c "echo 'extension=solr.so' > /etc/php/7.0/cli/conf.d/solr.ini"
sudo service apache2 restart

===== Linux (Redhat/Centos 6 & 7) =====

====== Using built in php5 packages ======
yum install php-pecl-solr2
service httpd restart

====== Using 3rd party php7 packages (webtactic) ======
yum install libxml2-devel pcre-devel libcurl-devel php70w-devel php70w-pear
pecl install solr
echo "extension=solr.so" > /etc/php.d/solr.ini
service httpd restart

===== OSX using macports =====

sudo port install apache-solr4
sudo port install php54-solr

===== OSX using homebrew =====

brew install homebrew/php/php56-solr

===== Windows =====

Install the pecl package as usual. (This has not yet been tested.)

===== The Solr server =====

Note that for medium/large sites you may need to increase maxBooleanClauses setting. In [https://tracker.moodle.org/browse/MDL-54992 MDL-54992] we are working on an alternative way to query the server.

Please note that there is a security issue that affects some Solr versions. The patched versions are 5.5.5, 6.6.2, 7.1, 7.2 and all new versions are patched. If your Solr server version is lower but you can't upgrade to one of the patched versions it is recommended to disable the XML Query Parser.

The following example snippet (feel free to copy & paste into a .sh script with execution permissions) will download Solr 5.5.5 (replace it with latest 5.x) in the current directory, start the solr server and create an index in it named '''moodle''' to add moodle data to it. If wget gives an error, check http://www-us.apache.org/dist/lucene/solr and update SOLRVERSION

#!/bin/bash
set -e
SOLRVERSION=5.5.5
SOLRNAME=solr-$SOLRVERSION
SOLRTAR=$SOLRNAME'.tgz'
INDEXNAME=moodle
if [ -d $SOLRNAME ]; then
echo "Error: Directory $SOLRNAME already exists, remove it before starting the setup again."
exit 1
fi
if [ ! -f $SOLRTAR ]; then
wget http://www-us.apache.org/dist/lucene/solr/$SOLRVERSION/$SOLRTAR
fi
tar -xvzf $SOLRTAR
cd $SOLRNAME
bin/solr start
bin/solr create -c $INDEXNAME
# After setting it up and creating the index use:
# - "/yourdirectory/solrdir/bin/solr start" from CLI to start the server
# - "/yourdirectory/solrdir/bin/solr stop" from CLI to stop the server.

======Solr 5/6 schema setup======

Moodle will use Solr's managed schema interface to install the required fields. You will be directed on what to do from the Manage global search page.

For very large or busy sites, it is recommended that you manually remove the '''_text_''' field, and associated copy directive from, the default Solr schema. This field is not used by Moodle, and will significantly slow indexing, and increase the size of the resulting Solr core.

======Solr 4 schema setup======

You cannot use the schema setup script when using a Solr 4 server. If you really want to use the Solr 4x branch, here are the field types descriptions:

Extracted from search/classes/document.php

{| class="nicetable"
|-
! Field name
! Field type
! Stored
! Indexed
! Query field
|-
| id
| org.apache.solr.schema.StrField
| true
| false
| false
|-
| itemid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| title
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| content
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| contextid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| areaid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| type
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| courseid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| owneruserid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| modified
| org.apache.solr.schema.TrieDateField
| true
| true
| false
|-
| userid
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| description1
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| description2
| org.apache.solr.schema.TextField
| true
| true
| true
|-
| solr_filegroupingid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileid
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_filecontenthash
| org.apache.solr.schema.StrField
| true
| true
| false
|-
| solr_fileindexstatus
| org.apache.solr.schema.TrieIntField
| true
| true
| false
|-
| solr_filecontent
| org.apache.solr.schema.TextField
| false
| true
| true
|}

======Memory and File indexing considerations======

For large sites, and particularly if you are using the File indexing feature, it's a good idea to give Solr plenty of memory, eg aound 10-20GB. To start Solr with more than its default 512MB of RAM, use the ''-m'' option:
solr start -m 12g

See the documents for your version of Solr on how to increases memory when Solr is started automatically.

======Too many boolean clauses error======

Because of the way Moodle handles permissions for searches, if you have non-admin users with access to a large number of activities (>1000), they may an error similar to the following:

The query you provided could not be parsed by the search engine: org.apache.solr.search.SyntaxError: Cannot parse
...
too many boolean clauses

To correct this, you need to increase the ''maxBooleanClauses'' setting in your Solr core. The setting is located in ''corename/conf/solrconfig.xml''.

This important note is included in the config file:
** WARNING **

This option actually modifies a global Lucene property that
will affect all SolrCores. If multiple solrconfig.xml files
disagree on this property, the value at any given moment will
be based on the last SolrCore to be initialized.

This means that for consistent behavior you should update this value for all cores in the Solr server.

=====Commannd for installing Solr Server on Centos 7=====
First of all install java (openjdk)
yum install java-1.8.0-openjdk
Add user for solr
adduser solr
Download solr server, find latest here : http://lucene.apache.org/solr/mirrors-solr-latest-redir.html, from the list there download latest solr-[version].tgz

Here is the list of needed commands (note that latest solr is suggested, change command to appropriate version)
cd /opt
wget http://www-eu.apache.org/dist/lucene/solr/6.6.0/solr-6.6.0.tgz
tar zxvf solr-6.6.0.tgz
cp solr-6.6.0/bin/install_solr_service.sh .
rm -rf solr-6.6.0
./install_solr_service.sh solr-6.6.0.tgz
chkconfig solr on
Create the index
su - solr -c "/opt/solr/bin/solr create_core -c moodle"
Then go to your Moodle and set index name as created (moodle)

==See also==

Forum discussions:
* [https://moodle.org/mod/forum/discuss.php?d=334938 Global search doesn't index plugins?]
* [https://moodle.org/mod/forum/discuss.php?d=339819 Global Search on Moodle 3.1]
* [https://moodle.org/mod/forum/discuss.php?d=384884 Global Search index repair]

'''MySQL Database Connection error with Simple Search:''' This SQL query should solve the issue

''ALTER TABLE mdl_search_simpledb_index ADD FULLTEXT(title, content, description1, description2)''

A quick introduction to Moodle global search, followed by a description of the new features and fixes in Moodle 3.4 (and some of those in Moodle 3.5).
*[https://www.slideshare.net/sammarshall_ou/moodle-global-search-nows-the-time-to-jump-in Presentation by Sam Marshall from the Open University]

[[es:Búsqueda global]]
[[de:Globale Suche]]
[[fr:Recherche globale]]

Moodle XML format

2019-09-15T18:03:38Z

Dschwa: /* Useful utilities */

{{Export questions}}
The XML Format is a Moodle-specific format for importing and exporting questions to be used with the [[Quiz module]]. The format has been developed within the Moodle Community but other software may support it to a greater or lesser degree.

==A word about validity (and CDATA)==

The XML parser assumes that the XML file is well formed and does not detect or report errors. If it is not you are very likely to get unexpected errors. If you are hand-coding the XML file it is strongly recommended that you pass it through some sort of XML verifier before importing into Moodle. A simple way to do this is to open the XML file using Firefox or Internet Explorer.

Note particularly that embedded HTML fragments should be within [http://en.wikipedia.org/wiki/CDATA CDATA sections]. CDATA example:

<code xml>
<questiontext format="html">
<text><![CDATA[
Now I can include any HTML that I 
wish. Without the CDATA, the HTML tags would break
the XML!!
]]>
</text>
</questiontext>
</code>

==Overall structure of XML file==

The file is enclosed by tags as follows. It is '''important''' to make sure the xml tag only is really the first line of the file. A blank first line, or additional tags on the first line will confuse the Moodle XML parser.

<code xml>
<?xml version="1.0" ?>
<quiz>
.
.
.
</quiz>
</code>

Within the <quiz> tags are any number of <question> tags. One of these <question> tags can be a dummy question with a ''category'' type to specify a category for the import/export.

<code xml>
<question type="category">
<category>
<text>$course$/XXXX</text>
</category>
</question>
</code>

Where XXXX is the new category name. If the category exists, the question(s) will be added to the existing course; otherwise a new category will be created. This only works if you have "Get category from file" checked.

Multiple categories can be specified in the same file. Just add another dummy 'category' question each time you would like to establish a new category and the questions that follow it will be placed there.

The file must be encoded in [[UTF8]]

Moodle XML import and export are balanced in functionality, so if you need to understand the format you can simply create some questions and export them to see what it looks like.

==Tags common to all question types==

A question is written as follows.

<code xml>
<question type="multichoice|truefalse|shortanswer|matching|cloze|essay|numerical|description">
<name>
<text>Name of question</text>
</name>
<questiontext format="html">
<text>What is the answer to this question?</text>
</questiontext>
.
.
.
</question>
</code>

Each question requires a <name> tag and <question-text> tag for the XML file to import into Moodle properly.

"Format" selects the [[Formatting options]] for the question text. The options are '''html''' (the default), '''moodle_auto_format''', '''plain_text''' and '''markdown'''. The choice effects the way in which the text will be displayed.

Further tags, which usually include at least one <answer> tag, follow in the space marked with dots as child nodes to the <question> tag. The response-related tags are listed further down on this page. Various (optional?) tags are possible.

* tags (non-hierarchical keywords)
* penalty
* generalfeedback
* defaultgrade
* hidden

Even though question tags (non-hierarchical keyowords) are not fully supported in the question engine, they can be imported and exported via XML.

<code xml>
<question ...>
...
<tags>
<tag>
<text>keyword1</text>
</tag>
<tag>
<text>keyword2</text>
</tag>
...
</tags>
...
</question>
</code>

The <image> tag contains the url of any included image. Nested within the <image> tag may be an <image_base64> tag which contains the actual image data encoded in base64 [http://www.php.net/manual/en/function.base64-encode.php].

{{Note|If you export questions from a Moodle 1.9 server, the exported file might contain only the relative URL to the image hosted in the 1.9 server, while exported questions from Moodle 2.x and 3.x severs might contain the actual image encoded in base 64. This explains why some question bank import-export operations include all the images and some others don't.}}
'''In the following question type examples the common parts of the question are not shown to improve clarity. It's a good idea to export some examples yourself to see a full example.'''

==Multiple choice==

MC questions have one <answer> tag for each choice. Each choice can carry feedback and score weighting (by using the fraction attribute). In addition, an MC question has the following tags:

* single ''(values: true/false)''
* shuffleanswers ''(values: 1/0)''
* correctfeedback
* partiallycorrectfeedback
* incorrectfeedback
* answernumbering (allowed values: 'none', 'abc', 'ABCD' or '123')

The <single> tag is used to distinguish single response (radio button) and multiple response (checkbox) variants.

<code xml>
<question type="multichoice">
<answer fraction="100">
<text>The correct answer</text>
<feedback><text>Correct!</text></feedback>
</answer>
<answer fraction="0">
<text>A distractor</text>
<feedback><text>Ooops!</text></feedback>
</answer>
<answer fraction="0">
<text>Another distractor</text>
<feedback><text>Ooops!</text></feedback>
</answer>
<shuffleanswers>1</shuffleanswers>
<single>true</single>
<answernumbering>abc</answernumbering>
</question>
</code>

== True/false ==

Two answer tags are given, one which is true, and one which is false. The fraction attribute of the answer tag identifies which option is correct (100) and which is false (0). Feedback is supported. The following example shows the format when true is the correct answer and false is wrong.

<code xml>
<question type="truefalse">
<answer fraction="100">
<text>true</text>
<feedback><text>Correct!</text></feedback>
</answer>
<answer fraction="0">
<text>false</text>
<feedback><text>Ooops!</text></feedback>
</answer>
</question>
</code>

== Short answer ==

The short answer question type supports alternative correct responses, each with its own weighting and feedback. The Moodle XML format uses one <answer> tag for each of the alternative correct answers.

The <usecase> tag toggles case-sensitivity with the values 1/0.

<code xml>
<question type="shortanswer">
<answer fraction="100">
<text>The correct answer</text>
<feedback><text>Correct!</text></feedback>
</answer>

<question type="shortanswer">
<answer fraction="100">
<text>The correct answer</text>
<feedback><text>Correct!</text></feedback>
</answer>
<answer fraction="100">
<text>An alternative answer</text>
<feedback><text>Correct!</text></feedback>
</answer>
</question>
</code>

== Numerical response ==

The following is a simplified version of the Moodle XML format for numerical responses.

<code xml>
<question type="numerical">
<answer fraction="100">
<text>23</text>
<feedback><text>Feedback</text></feedback>
</answer>
</question>
</code>

Moodle also supports a <tolerance> tag (how accurate must the number be?) and one or more <unit> tags. Unit tags have names and multipliers. E.g. if the main answer is in kilometres, an additional answer could be the equivalent in metres with a multiplier of 1000.

'''Note:''' prior to 1.7.2 the fraction was expressed as a value between 0 and 1 in a <fraction> element and the answer value was '''not''' enclosed in <text> tags. This format of the numerical question type is deprecated but will still be correctly imported if found (for now).

== Matching ==

Pair matching responses use the <shuffleanswers> tag to determine whether the order of the items should be randomized.
Each pair is contained inside a <subquestion> tag. The first item of each pair is contained with a <text> tag, while the second has an <answer> tag around it as well. Feedback and score weighting is not supported by Moodle for this response type.

<code xml>
<question type="matching">
<subquestion>
<text>This is the 1st item in the 1st pair.</text>
<answer>
<text>This is the 2nd item in the 1st pair.</text>
</answer>
</subquestion>
<subquestion>
<text>This is the 1st item in the 2nd pair.</text>
<answer>
<text>This is the 2nd item in the 2nd pair.</text>
</answer>
</subquestion>
<shuffleanswers>true</shuffleanswers>
</question>
</code>

== Essay ==

An example of the essay type question...

<code xml>
<question type="essay">
<answer fraction="0">
<text></text>
</answer>
</question>
</code>

There isn't an answer and there isn't a grade in this case.

'''Note:''' prior to 1.7.2 the fraction was expressed as a value between 0 and 1 in a <fraction> element and the answer value was '''not''' enclosed in <text> tags. This format of the essay question type is deprecated but will still be correctly imported if found (for now).

== Other question types ==

=== Cloze ===

It is supported, and depends on a special format for the <questiontext> tag.

=== Description response type===

This response type has no further tags other than those contained in the question header (such as <questiontext>).

=== Random matching ===

Moodle has a question type which consists of taking short answer questions in the same quiz and displaying them as a pair matching exercise. However Moodle is neither able to export nor import this question type.

==Text formats==

Moodle XML files should explicity specify the text format ('''html''', '''moodle_auto_format''', '''plain_text''' and '''markdown''' - these correspond to the constants , FORMAT_HTML, FORMAT_MOODLE, etc used in the Moodle code) for each piece of content. Note that, by default, the format should be specified on the parent of the <text> element. This is slightly odd, but a remnant of history.

If the format is not specified for the questiontext, then '''html''' is the default. If the format is not specified on any other part of the question, then the format of the questiontext is the default.

(This default changed around November 2011. Before that, the default was '''moodle_auto_format''' whenever the format was not specified.)

==Useful utilities==
*[http://vletools.com Online Moodle XML converter] Convert from existing text files glossaries and quizzes to Moodle XML format. Also can convert from Moodle XMl to text.
*[http://finemetronome.com/moodle/ Word Template for generating Moodle XML].- URL appears to be degraded and no longer working
*[http://www.learningseekers.com/products MoXMLE - A Java based application] MoXMLE is a Java based application that converts a Simple TXT file into a Moodle XML format.

== See also ==
* [http://www.qedoc.org/index.php?title=Moodle_XML_format Quedoc's Moodle XML documentation]
* [[User:Frank Ralf/Moodle XML1]] (work in progress)
*[[Aiken format]]
*[[XML FAQ]]
*[[Import and export FAQ]]

[[ja:Moodle XMLフォーマット]]
[[de: Moodle XML-Format]]
[[fr:Format XML Moodle]]
[[es:Formato Moodle XML]]

Git for Administrators

2018-08-08T15:09:28Z

Dschwa:

{{Installing Moodle}}
This page describes how to maintain a copy of Moodle on your production server which can easily be upgraded using Git. If you have customisations of Moodle core code, you are advised to follow the instructions in the [[:dev:Git for developers|Git for developers guide]].

To get the most of Git it is worth making the effort to understand its basic concepts - see the section below. It can be a bit of a steep learning curve, especially if you are used to CVS or Subversion.

== Getting hold of Git (Windows, OSX, Linux and others) ==

Support for Git was, up until recently, mostly confined to Linux but builds are now available for most popular operating systems:

* List of downloads from Git site - http://git-scm.com/download

Once you have downloaded and installed your OS relevant git installation, the git commands in this document should work with your operating system.

== Obtaining the code from Git ==

The command line version of Git is discussed here. Graphical clients are little more than wrappers around the command line version, so you should be able to deduce the correct parameters quite easily.

You can find the official Moodle git repository at git://git.moodle.org/moodle.git (with an official clone at git://github.com/moodle/moodle.git). To initialize your local checkout, use
<pre>
$ cd /path/to/your/webroot
$ git clone git://git.moodle.org/moodle.git (1)
$ cd moodle
$ git branch -a (2)
$ git branch --track MOODLE_35_STABLE origin/MOODLE_35_STABLE (3)
$ git checkout MOODLE_35_STABLE (4)
</pre>
* The command (1) initializes the new local repository as a clone of the 'upstream' (i.e. the remote server based) moodle.git repository. The upstream repository is called 'origin' by default. It creates a new directory named ''moodle'', where it downloads all the files. This operation can take a while as it is actually getting the entire history of all Moodle versions
* The command (2) lists all available branches.
* Use the command (3) to create a new local branch called MOODLE_35_STABLE and set it to track the remote branch MOODLE_35_STABLE from the upstream repository.
* The command (4) actually switches to the newly created local branch.
==Git Connection Refused Error==
*If connection refused, use: $ git clone https://github.com/moodle/moodle.git
''fatal: unable to connect to git.moodle.org:
git.moodle.org[0: 34.210.133.53]: errno=Connection refused''

Note that Git has a huge number of options for each command and it's actually possible to do the above process with a single command (left as an exercise!!).

==Git from behind a firewall==

Git uses a read-only protocol that may be blocked by your firewall (port 9418). If this is a problem, you can use Github's http version <nowiki>https://github.com/moodle/moodle.git</nowiki>. It's a bit slower, so use the Git protocol if you can.

== Updating your installation ==

The Moodle development team performs integration and testing of fixed bugs every Monday and Tuesday. On Wednesday you can install all patches by updating your code. Check the [http://git.moodle.org/gw?p=moodle.git;a=summary shortlog] to see if the official repository has been already updated or not.

To update your code to the latest version (on the MOODLE_35_STABLE branch) '''all''' you have to do is:
<pre>
$ cd /path/to/your/moodle/
$ git pull
</pre>
If this is a production site you should still consider the [[Upgrade]] instructions (e.g. take backups).

== Installing a contributed extension from its Git repository ==

This is one way to handle adding plugins from other Git repositories into your Moodle repository. Another way is to use Git Submodules. However, at the time of writing, this is one of Git's rougher features and should be regarded as an advanced option.

For example, let us say we want to install the [[Certificate module]] from its Git repository into our Moodle {{Version}}.
<pre>
$ cd /path/to/your/moodle/
$ cd mod (1)
$ git clone https://github.com/markn86/moodle-mod_certificate.git certificate (2)
$ cd certificate
$ git checkout -b MOODLE_35_STABLE origin/MOODLE_35_STABLE (3)
$ git branch -d master (4)
</pre>
The command (1) changes the current directory into the ''mod'' folder of your local Moodle clone. The command (2) creates a new subdirectory ''certificate'' and makes a local clone of vanilla Certificate repository. The command (3) creates a new local branch that will track the remote branch with a Certificate version for Moodle {{Version}}. The command (4) deletes the ''master'' that was created automatically by git-clone in (2) as we do not want it in this production checkout.

Note: you should check first the compatibility of a module with your Moodle branch by asking directly to the Maintainer before cloning the repo or - if you want to guess it - by issuing the command below before running the command (3), in order to verify what is available among the branches:
<pre>
$ git branch -a
* master
remotes/origin/HEAD -> origin/master
remotes/origin/MOODLE_20_STABLE
remotes/origin/MOODLE_21_STABLE
remotes/origin/MOODLE_22_STABLE
remotes/origin/MOODLE_23_STABLE
remotes/origin/MOODLE_24_STABLE
remotes/origin/MOODLE_25_STABLE
remotes/origin/MOODLE_26_STABLE
remotes/origin/MOODLE_27_STABLE
remotes/origin/MOODLE_28_STABLE
remotes/origin/MOODLE_29_STABLE
remotes/origin/MOODLE_30_STABLE
remotes/origin/MOODLE_31_STABLE
remotes/origin/master
</pre>
This will avoid an error message when you issue the command (3) against a nonexistent branch, e.g.:
<pre>
§ git checkout -b MOODLE_31_STABLE origin/MOODLE_31_STABLE
fatal: git checkout: updating paths is incompatible with switching branches.
Did you intend to checkout 'origin/MOODLE_31_STABLE' which can not be resolved as commit?
</pre>

Note: To fix above error, use: "git fetch origin MOODLE_31_STABLE:LOCAL_MOODLE_31_STABLE"

Now it is wise to add the new directory mod/certificate/ to the list of ignored files of the main Moodle clone, otherwise a status of the main clone will keep reminding you that the new code has not been checked in.
<pre>
$ cd /path/to/your/moodle/
$ echo /mod/certificate/ >> .git/info/exclude
</pre>
To update your Moodle installation now, you must visit both Git repositories and pull changes from upstream.
<pre>
$ cd /path/to/your/moodle/
$ git pull
$ cd mod/certificate
$ git pull
</pre>
Writing a shell script with these lines in the root of Moodle installation is a very good idea. Otherwise it is easy to forget what Git repositories are there within the main Moodle repository.

== Installing and maintaining contributed extensions using Git submodules ==

As it was said in the previous section, this is for advanced users only.
Therefore it is necessary, that you have some experience with Git and its commands.
A step-by-step explanation will be provided, but in order to follow these steps it is helpful to understand, what these commands do.

Advanced options and commands can be found at [[https://git-scm.com/book/en/v2/Git-Tools-Submodules|the Git book]].
If you have any questions about Git submodules, please visit the site above first.

=== Installing a new extension into an existing Moodle ===

As an example we use the [[Certificate module]] from the previous section.
<pre>
$ cd /path/to/your/moodle
$ git submodule add https://github.com/markn86/moodle-mod_certificate.git mod/certificate
</pre>

Note, that Git is reporting two new files in the repository:
<pre>
$ git status
# On branch MOODLE_29_STABLE
# Changes to be committed:
# (use "git reset HEAD <file>..." to unstage)
#
# new file: .gitmodules
# new file: mod/certificate
#
</pre>

The file '''.gitmodules''' contains the local path and url of all your submodules.
It has to be commited, if you intend to clone the repository later (see the page [[Moodle development environment with Git submodules]]).
Before commiting, make sure to check the configuration of the plugin's Git repository, since the automatically generated settings may be not sufficient.
For future updates it is helpful, to track the remote branch, which corresponds to the Moodle version of your repository.
<pre>
$ cd mod/certificate
$ git branch -avv
* master 345f5b1 [origin/master] Replaced deprecated function
remotes/origin/HEAD -> origin/master
remotes/origin/MOODLE_20_STABLE 1aa1040 Added option to print 'grade category' grade
remotes/origin/MOODLE_21_STABLE 1aa1040 Added option to print 'grade category' grade
remotes/origin/MOODLE_22_STABLE 1aa1040 Added option to print 'grade category' grade
remotes/origin/MOODLE_23_STABLE fe047de Check that the function exists rather than relying on the Moodle version
remotes/origin/MOODLE_24_STABLE 1051f7d CONTRIB-4892 Fixed the email to others functionality
remotes/origin/MOODLE_25_STABLE cdb221a CONTRIB-4946: Removed character from language file breaking AMOS
remotes/origin/MOODLE_26_STABLE 696802a Increased version
remotes/origin/MOODLE_27_STABLE d3c0379 Increased version
remotes/origin/MOODLE_28_STABLE fa8df83 Increased version
remotes/origin/MOODLE_29_STABLE 3f03740 Replaced deprecated function
remotes/origin/master 345f5b1 Replaced deprecated function
</pre>

Git created the branch '''master''' which tracks '''origin/master''' automatically, because the remote repository has checked out '''master'''.
Therefore, create a new branch, which tracks the appropriate remote branch.
Of course, this is only possible, if the remote repository offers those branches.
<pre>
$ git checkout -b MOODLE_29_STABLE origin/MOODLE_29_STABLE
Branch MOODLE_29_STABLE set up to track remote branch MOODLE_29_STABLE from origin.
Switched to a new branch 'MOODLE_29_STABLE'
$ git branch -D master
Deleted branch master (was 345f5b1).
</pre>
It is not necessary to delete the '''master''' branch, but it's useless to keep it.
In fact, these settings don't need to be touched afterwards.

The final step is to commit the changes to the main repository.
<pre>
$ cd /path/to/your/moodle
$ git commit -a -m "New extension mod_certificate installed"
</pre>

It has to be ensured, that the commit includes only the changes for the new Git submodule (since '''-a''' commits all non-staged changes).

=== Maintaining Git submodules ===

Maintaining a set of submodules is extremly easy.
Consider a Moodle repository with several submodules installed.
Keep in mind, that the extension '''mod_mylittleextension''' is a fake plugin, created for a test scenario in this example.
It is not an official Moodle module. For updating all your submodules at once, type in:
<pre>
$ cd /path/to/your/moodle
$ git submodule foreach git pull
Entering 'block/coursefeedback'
Already up-to-date.
Entering 'mod/certificate'
Already up-to-date.
Entering 'mod/mylittleextension'
remote: Counting objects: 6, done.
remote: Compressing objects: 100% (4/4), done.
remote: Total 4 (delta 0), reused 0 (delta 0)
Unpacking objects: 100% (4/4), done.
From /local/repositories/mle
89d9eae..64c122d master -> origin/master
Updating 89d9eae..64c122d
Fast-forward
index.html | 9 +++++++++
version.php | 6 +++---
2 files changed, 12 insertions(+), 3 deletions(-)
create mode 100644 index.html
$ git status
# On branch MOODLE_29_STABLE
# Changes not staged for commit:
# (use "git add <file>..." to update what will be committed)
# (use "git checkout -- <file>..." to discard changes in working directory)
#
# modified: mod/mylittleextension (new commits)
#
</pre>

The command '''git submodule foreach [another command]''' walks through all submodule repositiories and executes what is specified by '''[another command]'''.
In this case it is '''git pull'''.
Therefore the module mylittleextension was updated and the main repository isn't clean anymore until changes are committed:
<pre>
$ git commit -a -m "Plugin updates"
</pre>

Maintaining plugins with Git submodules has also another application than simplyfying the update process.
In a greater scale it can be used to maintain a Moodle project, where multiple developers need to have an exact copy of your moodle without organizing external plugins manually.
You can read more about this topic at the page [[Moodle development environment with Git submodules]].

== See also ==

* [[Windows installation using Git]]
* [[Git for Mac]]
* [[:dev:Moodle versions]]
* For fixing a Tracker Issue (MDL) / Forking Moodle / CONTRIButing code [[:dev:User:Sam_Hemelryk/My_Moodle_Git_workflow|User:Sam_Hemelryk/My_Moodle_Git_workflow]]
* [[Moodle_Production_Server_with_GIT|Case study Git + Moodle from Technical University Berlin]]

; Moodle forum discussions
* [https://moodle.org/mod/forum/discuss.php?d=255175 Github and Moodle deployment for production]
* [http://moodle.org/mod/forum/discuss.php?d=168094 GIT help needed]
* [https://moodle.org/mod/forum/discuss.php?d=231046 Clear git guide for Admins (not developers)]

; External resources
* [http://thamblings.blogspot.com.au/2013/07/upgrading-moodle-from-git.html Deploying Moodle from git - Blog post from a production experience]
* [http://gitref.org/ Git Reference]
* [http://progit.org/book/ Pro Git book]

[[ja:管理者用Git]]
[[fr:Git_pour_administrateurs]]
[[es:Git para Administradores]]

Word censorship filter

2018-04-20T13:09:38Z

Dschwa: /* Tips and Tricks */

{{Filters}}
The word censorship filter enables certain user-selected words to be "blacked out" in the flow of any text submitted within a course. The primary use is for censoring obscene or other unwanted words entered by learners in activities like Forums and Wikis.

==Custom list of censored Words==

The word censorship settings page ''Administration > Site administration > Plugins > Word censorship'' allows a site administrator to edit a custom list of words (bad words) to be censored within your Moodle installation.

To avoid inadvertently causing offence, there is no default bad word list on the Word censorship settings page. If the custom list is empty, the default list from the language pack will be used.

==Default censored Words==

The default bad word list is contained within the censor.php file within each language pack installed on your Moodle site. To change the default bad word list go to ''Administration > Site administration > Language > Language Customization'' and check out the required language pack. Select the censor.php file under the '''filters''' subheading from the strings list and click '''Show strings'''. Warning: You may find the content of this file offensive.

==Tips and Tricks==
*If you would prefer not to display a custom list of censored words on the Word Censorship Settings page, customize the censor.php file the language directly
*If you have multiple language packs installed and in use within your Moodle site, remember to edit each language pack and/or add custom censored words in all languages.

==See also==

*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=79711 filtering profanity] forum discussion

[[Category:Site administration]]

[[de:Wortzensur]]
[[es:Palabras censuradas (filtro)]]
[[fr:Filtre censure de mots inadéquats]]
[[ja:ワードセンサーシップ]]

ad-hoc contributed reports

2010-06-28T13:46:00Z

Dschwa:

These are community contributed reports for the [[Custom_SQL_queries_report]] site-wide report plugin (module) 
Everyone is welcome to add their own. until we find a better way to exchange reports between us. 
Enjoy :-) 

----

===Detailed ACTIONs for each MODULE===
<code sql>
SELECT module,action,count(id) as counter
FROM prefix_log
GROUP BY module,action
ORDER BY module,counter desc
</code>

===Detailed ACTIONs for each ROLE (TEACHER,NONE-EDITING TEACHER and STUDENT)===
<code sql>
SELECT r.name,l.action, count( l.userid ) as counter
FROM `prefix_log` as l
JOIN `prefix_role_assignments` AS ra on l.userid = ra.userid
JOIN prefix_role AS r ON ra.roleid = r.id
WHERE ra.roleid IN (3,4,5)
GROUP BY roleid,l.action
ORDER BY counter desc
</code>

===Detailed "VIEW" ACTION for each ROLE (TEACHER,NONE-EDITING TEACHER and STUDENT)===
<code sql>
SELECT l.action, count( l.userid ) as counter , r.name
FROM `prefix_log` as l
JOIN `prefix_role_assignments` AS ra on l.userid = ra.userid
JOIN `prefix_role` AS r ON ra.roleid = r.id
WHERE (ra.roleid IN (3,4,5)) AND (l.action LIKE '%view%' )
GROUP BY roleid,l.action
order by r.name,counter desc
</code>

===Most Active courses===
<code sql>
SELECT COUNT(l.id) hits, l.course courseId, c.fullname coursename
FROM prefix_log l INNER JOIN prefix_course c ON l.course = c.id
GROUP BY courseId
ORDER BY hits DESC
</code>

===RESOURCE count for each COURSE===
<code sql>
SELECT COUNT(l.id) count, l.course, c.fullname coursename
FROM prefix_resource l INNER JOIN prefix_course c on l.course = c.id
GROUP BY course
ORDER BY count DESC
</code>

===Most popular ACTIVITY===
<code sql>
SELECT COUNT(l.id) hits, module
FROM prefix_log l
WHERE module != 'login' AND module != 'course' AND module != 'role'
GROUP BY module
ORDER BY hits DESC
</code>

===System wide use of ACTIVITIES and RESOURCES===
<code sql>
SELECT count( cm.id ) AS counter, m.name
FROM `prefix_course_modules` AS cm
JOIN prefix_modules AS m ON cm.module = m.id
GROUP BY cm.module
ORDER BY counter DESC
</code>

===LOG file ACTIONS per MODULE per COURSE (IDs)===
<code sql>
select course,module,action,count(action) as summa from prefix_log
where action <> 'new'
group by course,action,module
order by course,module,action
</code>

==="Compose Web Page" RESOURCE count===
<code sql>
SELECT course,prefix_course.fullname, COUNT(*) AS Total
FROM `prefix_resource`
JOIN `prefix_course` ON prefix_course.id = prefix_resource.course
WHERE type='html'
GROUP BY course
</code>

ad-hoc contributed reports

2010-06-28T13:45:40Z

Dschwa: /* = */

ad-hoc contributed reports

2010-06-28T13:44:56Z

Dschwa: /* Your Personal Resource View Report "Where did I leave off?" */

ad-hoc contributed reports

2010-06-21T12:24:15Z

Dschwa: