https://docs.moodle.org/310/en/api.php?action=feedcontributions&feedformat=atom&user=CabeasleyMoodleDocs - User contributions [en]2026-04-18T13:49:58ZUser contributionsMediaWiki 1.43.5https://docs.moodle.org/310/en/index.php?title=Game_module_configure&diff=60757Game module configure2009-07-30T16:47:04Z<p>Cabeasley: /* Hidden Picture */</p>
<hr />
<div>=All Games=<br />
* To insert a new game use “Add an activity” <br />
<br />
[[Image:Module game configure1.png]]<br />
<br />
* After this the program show the first screen where you can set only the name and the visibility of the new game.<br />
<br />
<br />
[[Image:module game configure2.png]]<br />
<br />
* After the you must use the button “Update the game” to select the kind of game and to set some parameters. <br />
<br />
[[Image:module game configure3.png]]<br />
<br />
* Now you can select the kind of game (e.g. hangman, crossword, cryptex) and the source.<br />
<br />
Depending on the game, you have 3 options for the source:<br />
<br />
a) Use a glossary as the source (all or only one category). Hangman, Crossword and Cryptex all require a glossary as the source.<br />
<br />
b) Use questions as the source. The kind of questions are “simple answer”, multiple choice, and true/false.<br />
<br />
c) Use a quiz as the source.<br />
<br />
Every game needs a different kind of question. For example hangman needs “simple answer” and millionaire needs multiple choice. <br />
<br />
[[Image:module game configure4.png]]<br />
<br />
Notes:<br />
* Input files must be UTF-8 encoded<br />
<br />
==Book With Questions==<br />
The Book With Questions game requires that the Book module be installed.<br />
<br />
==Crossword==<br />
<br />
==Cryptex==<br />
<br />
==Hangman==<br />
<br />
==Hidden Picture==<br />
The images must be attachments.<br />
<br />
If the glossary concept or the question answer contains spaces, then "Allow Spaces in Words" must be set to "Yes" in the game configuration.<br />
<br />
==Snakes and Ladders==<br />
<br />
==Sudoku==</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module_configure&diff=60756Game module configure2009-07-30T16:38:59Z<p>Cabeasley: /* Hidden Picture */</p>
<hr />
<div>=All Games=<br />
* To insert a new game use “Add an activity” <br />
<br />
[[Image:Module game configure1.png]]<br />
<br />
* After this the program show the first screen where you can set only the name and the visibility of the new game.<br />
<br />
<br />
[[Image:module game configure2.png]]<br />
<br />
* After the you must use the button “Update the game” to select the kind of game and to set some parameters. <br />
<br />
[[Image:module game configure3.png]]<br />
<br />
* Now you can select the kind of game (e.g. hangman, crossword, cryptex) and the source.<br />
<br />
Depending on the game, you have 3 options for the source:<br />
<br />
a) Use a glossary as the source (all or only one category). Hangman, Crossword and Cryptex all require a glossary as the source.<br />
<br />
b) Use questions as the source. The kind of questions are “simple answer”, multiple choice, and true/false.<br />
<br />
c) Use a quiz as the source.<br />
<br />
Every game needs a different kind of question. For example hangman needs “simple answer” and millionaire needs multiple choice. <br />
<br />
[[Image:module game configure4.png]]<br />
<br />
Notes:<br />
* Input files must be UTF-8 encoded<br />
<br />
==Book With Questions==<br />
The Book With Questions game requires that the Book module be installed.<br />
<br />
==Crossword==<br />
<br />
==Cryptex==<br />
<br />
==Hangman==<br />
<br />
==Hidden Picture==<br />
The images must be attachments.<br />
<br />
If the glossary "Concept" field contains spaces, then "Allow Spaces in Words" must be set to "Yes"<br />
<br />
==Snakes and Ladders==<br />
<br />
==Sudoku==</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module_configure&diff=60704Game module configure2009-07-29T18:35:20Z<p>Cabeasley: /* Hidden Picture */</p>
<hr />
<div>=All Games=<br />
* To insert a new game use “Add an activity” <br />
<br />
[[Image:Module game configure1.png]]<br />
<br />
* After this the program show the first screen where you can set only the name and the visibility of the new game.<br />
<br />
<br />
[[Image:module game configure2.png]]<br />
<br />
* After the you must use the button “Update the game” to select the kind of game and to set some parameters. <br />
<br />
[[Image:module game configure3.png]]<br />
<br />
* Now you can select the kind of game (e.g. hangman, crossword, cryptex) and the source.<br />
<br />
Depending on the game, you have 3 options for the source:<br />
<br />
a) Use a glossary as the source (all or only one category). Hangman, Crossword and Cryptex all require a glossary as the source.<br />
<br />
b) Use questions as the source. The kind of questions are “simple answer”, multiple choice, and true/false.<br />
<br />
c) Use a quiz as the source.<br />
<br />
Every game needs a different kind of question. For example hangman needs “simple answer” and millionaire needs multiple choice. <br />
<br />
[[Image:module game configure4.png]]<br />
<br />
Notes:<br />
* Input files must be UTF-8 encoded<br />
<br />
==Book With Questions==<br />
The Book With Questions game requires that the Book module be installed.<br />
<br />
==Crossword==<br />
<br />
==Cryptex==<br />
<br />
==Hangman==<br />
<br />
==Hidden Picture==<br />
If using a Glossary as the source of questions for Hidden Picture, the images must be attachments to the glossary entries.<br />
<br />
The glossary "Concept" field cannot contain spaces.<br />
<br />
==Snakes and Ladders==<br />
<br />
==Sudoku==</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Development:Setting_up_Eclipse&diff=59829Development:Setting up Eclipse2009-07-14T19:14:11Z<p>Cabeasley: /* Installing the necessary plugins */</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
Since this page was written, Eclipse 3.3 and 3.4 have been released, along with a new PHP plugin called PDT, which is better, but uses more memory. You can download an all-in-one Eclipse+PDT from http://www.eclipse.org/pdt/downloads/. The following instructions, from the section [[#Setting_the_preferences_for_Moodle_development]] mostly still apply after you have done the install, but some of the details are a bit different.--[[User:Tim Hunt|Tim Hunt]] 07:30, 31 January 2009 (CST)<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it creates a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step. (On Eclipse 3.4.0 on OSX this is in '''Eclipse > Preferences > General > Network Connections''')<br />
<br />
From the '''Help''' menu choose '''Check for Updates'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://update.phpeclipse.net/update/nightly; then click '''OK'''. Click '''Finish'''. Under '''PHPEclipse Nightly Builds''', check '''PHPeclipse'''. Click '''Finish'''. Wait while it downloads (this may take a few minutes). Click '''Install'''. You will be prompted to restart Eclipse, click '''Restart'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Restart the wizard (from the '''Help''' menu choose '''Software Updates -> Find and Install'''). <br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
Select just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site''').<br />
Then click '''Finish'''.<br />
<br />
It goes off and sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want (Select the features to install). The ones you want (you may have to expand and search the tree structure) are: all the '''PHPEclipse Nightly Builds''' (from your newly created PHPEclipse Update Site) and the '''Web Standard Tools (WST)''' (usually under Callisto or Europa Discovery Site --> Web and J2EE Development). <br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation built digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box (use the '''Default''' button - the default will appear at the top of the list). <br />
<br />
With '''*.html''' selected in the top box, if it is not already there, add '''PHP Editor''' to the bottom box. Then select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Network Connections'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
Under '''General -> Editors -> Text Editors''', check '''Show line numbers''' to display line numbers in the left margin (optional). Click '''Apply'''. (When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.)<br />
<br />
Under '''PHPeclipse -> Browser Preview Defaults''', turn off all checkboxes (if necessary). Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4 (if necessary). Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Editor''', turn on '''Remove trailing spaces on editor save'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS''', on the '''Files and Folders''' tab, set '''Default text mode''' to '''ASCII with keyword expansion (-kkv)'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
For each XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XML Files -> Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-highlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should find that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project...''' That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all of the really important features. I'm sure you can learn everything else on your own. And you can always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right-click an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right-click an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. Right-click it and expand configure branches and versions.<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. Select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. Locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update, I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
<br />
[[Category:Developer|Eclipse]]<br />
[[Category:Developer tools|Eclipse]]<br />
<br />
[[fr:Développement:Eclipse]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Development:Setting_up_Eclipse&diff=59826Development:Setting up Eclipse2009-07-14T19:08:27Z<p>Cabeasley: </p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
Since this page was written, Eclipse 3.3 and 3.4 have been released, along with a new PHP plugin called PDT, which is better, but uses more memory. You can download an all-in-one Eclipse+PDT from http://www.eclipse.org/pdt/downloads/. The following instructions, from the section [[#Setting_the_preferences_for_Moodle_development]] mostly still apply after you have done the install, but some of the details are a bit different.--[[User:Tim Hunt|Tim Hunt]] 07:30, 31 January 2009 (CST)<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it creates a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step. (On Eclipse 3.4.0 on OSX this is in '''Eclipse > Preferences > General > Network Connections''')<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://update.phpeclipse.net/update/nightly; then click '''OK'''. Click '''Finish'''. Under '''PHPEclipse Nightly Builds''', check '''PHPeclipse'''. Click '''Finish'''. Wait while it downloads (this may take a few minutes). Click '''Install'''. You will be prompted to restart Eclipse, click '''Restart'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Restart the wizard (from the '''Help''' menu choose '''Software Updates -> Find and Install'''). <br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
Select just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site''').<br />
Then click '''Finish'''.<br />
<br />
It goes off and sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want (Select the features to install). The ones you want (you may have to expand and search the tree structure) are: all the '''PHPEclipse Nightly Builds''' (from your newly created PHPEclipse Update Site) and the '''Web Standard Tools (WST)''' (usually under Callisto or Europa Discovery Site --> Web and J2EE Development). <br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation built digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box (use the '''Default''' button - the default will appear at the top of the list). <br />
<br />
With '''*.html''' selected in the top box, if it is not already there, add '''PHP Editor''' to the bottom box. Then select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Network Connections'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
Under '''General -> Editors -> Text Editors''', check '''Show line numbers''' to display line numbers in the left margin (optional). Click '''Apply'''. (When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.)<br />
<br />
Under '''PHPeclipse -> Browser Preview Defaults''', turn off all checkboxes (if necessary). Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4 (if necessary). Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Editor''', turn on '''Remove trailing spaces on editor save'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS''', on the '''Files and Folders''' tab, set '''Default text mode''' to '''ASCII with keyword expansion (-kkv)'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
For each XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XML Files -> Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-highlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should find that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project...''' That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all of the really important features. I'm sure you can learn everything else on your own. And you can always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right-click an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right-click an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. Right-click it and expand configure branches and versions.<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. Select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. Locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update, I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
<br />
[[Category:Developer|Eclipse]]<br />
[[Category:Developer tools|Eclipse]]<br />
<br />
[[fr:Développement:Eclipse]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Template:Game&diff=59820Template:Game2009-07-14T15:05:32Z<p>Cabeasley: </p>
<hr />
<div><div class="sideblock right" style="width: 12em;"><br />
<div class="header">[[Game module]]</div><br />
<div class="content"><br />
* [[Game_module_install|How to install]]<br />
* [[Game_module_configure|How to configure]]<br />
* [[Game_module_demo|References & Demo video]]<br />
* [[Game_module_developers|Info for developers]]<br />
* [[Game_module_howtohelp|How I can help?]]<br />
* [[Game_module_public|Publishes]]<br />
* [[Game_module_sites|Sites that uses it]]<br />
* [[Game_FAQ|Game module FAQ]]<br />
</div><br />
</div></div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Template:Game&diff=59819Template:Game2009-07-14T15:05:01Z<p>Cabeasley: </p>
<hr />
<div><div class="sideblock right" style="width: 12em;"><br />
<div class="header">[[Game module]]</div><br />
<div class="content"><br />
* [[Game_module_install|How to install]]<br />
* [[Game_module_configure|How to configure]]<br />
* [[Game_module_demo|References & Demo video]]<br />
* [[Game_module_developers|Info for developers]]<br />
* [[Game_module_howtohelp|How I can help?]]<br />
* [[Game_module_public|Publishes]]<br />
* [[Game_module_sites|Sites that uses it]]<br />
* [[Game_FAQ|Game module FAQ<br />
</div><br />
</div></div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_FAQ&diff=59818Game FAQ2009-07-14T15:03:26Z<p>Cabeasley: </p>
<hr />
<div>{{Game}}<br />
<br />
== Where can I learn more about the Game module? ==<br />
In the [http://moodle.org/mod/forum/view.php?id=7220 Game module forum]<br />
<br />
== See also: ==<br />
* [[MoodleDocs:Guidelines_for_contributors#Creating_new_pages| Guidelines for contributors: Creating new pages]]<br />
<br />
[[Category:FAQ]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_FAQ&diff=59817Game FAQ2009-07-14T15:00:58Z<p>Cabeasley: New page: {{Game}} == What is XXX? == == Where can I find information about XXX? == == How is XXX used by Moodle? == == See also: == * [[MoodleDocs:Guidelines_for_contributors#Creating_new_pag...</p>
<hr />
<div>{{Game}}<br />
<br />
== What is XXX? ==<br />
<br />
== Where can I find information about XXX? ==<br />
<br />
== How is XXX used by Moodle? ==<br />
<br />
<br />
== See also: ==<br />
<br />
* [[MoodleDocs:Guidelines_for_contributors#Creating_new_pages| Guidelines for contributors: Creating new pages]]<br />
<br />
[[Category:FAQ]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Template:Game&diff=59816Template:Game2009-07-14T14:56:46Z<p>Cabeasley: </p>
<hr />
<div><div class="sideblock right" style="width: 12em;"><br />
<div class="header">[[Game module]]</div><br />
<div class="content"><br />
* [[Game_module_install|How to install]]<br />
* [[Game_module_configure|How to configure]]<br />
* [[Game_module_demo|References & Demo video]]<br />
* [[Game_module_developers|Info for developers]]<br />
* [[Game_module_howtohelp|How I can help?]]<br />
* [[Game_module_public|Publishes]]<br />
* [[Game_module_sites|Sites that uses it]]<br />
* [[Game_module_faq|Game module FAQ<br />
</div><br />
</div></div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Sandbox&diff=59812Sandbox2009-07-14T14:21:22Z<p>Cabeasley: </p>
<hr />
<div><nowiki>Insert non-formatted text here like this</nowiki><br />
<br />
['''International Institute for the Sociology of Law'''][http://www.iisj.es] ==<br />
''''''[Library][http://www.iisje.es.bdiisj/]''''''''Master Course 2009-2010''<br />
<br />
== [[Master Course Bibliography]] ==<br />
<br />
<br />
== Testing ==[[Image:Example.jpg]]<nowiki><nowiki>Insert non-formatted text here</nowiki><nowiki><nowiki>Insert non-formatted text here</nowiki></nowiki></nowiki><br />
<br />
<br />
hello I want to try<br />
[['''''<br />
Melody is testing driving Moodle!''''']][www.mjbuckner.com]<br />
Here is a tesst from Tom<br />
<br />
Add text here<br />
<br />
----<br />
<br />
== '''Major Heading'''[http://gallery.me.com/pnetterfield] ==<br />
<br />
Hello World<br />
<br />
Table Setup:<br />
<br />
{| class="table"<br />
|-<br />
! Column 1<br />
! Column 2<br />
! Column 3<br />
|-<br />
| '''row 1, cell 1'''<br />
| ''row 1, cell 2''<br />
| [[row 1, cell 3]]<br />
|-<br />
| row 2, cell 1<br />
| row 2, cell 2<br />
| row 2, cell 3<br />
|-<br />
| row 3, cell 1<br />
| row 3, cell 2<br />
| row 3, cell 3<br />
|}<br />
----<br />
<br />
<br />
'''Testing Moodle'''... ''XD'' ...<br />
<br />
[[Media:Example.ogg]] [[Image:Example.jpg]] [http://www.example.com link title]<br />
<br />
<br />
<br />
<br />
<br />
----<br />
<br />
<br />
<br />
'''Trying to work out what this does'''<br />
<br />
three apostrophes make things bold. '''What happens if I just type them''' Does the same thing work for ''italics''<br />
<br />
<br />
''== Apparently so ==''<br />
<br />
'''Glen is testing this page'''<br />
<br />
== Headline text ==<br />
[http://www.moodle.org]<br />
<br />
Moodling around with LMS and links that work? [[Media:[www.moodle.org]]<br />
<br />
===testing editing capabilities===<br />
[[Image:Example.jpg ]]<br />
[['''Finding it difficult to get going with my own page''']]'''Bold text'''==Example==<br />
'''Editing in the Sandbox'''<br />
<br />
This is the first time I have edited in Moodle.<br />
<br />
[[Hello world!!!]][http://www.stuff.com Hello]<br />
I don't really know how this all works, but I'm figuring it out slowly!!![http://www.example.com link title]<br />
<br />
How is everyone?<br />
<br />
'''Helloooooooooooooooooooooo'''<br />
<br />
'''testing, 1,2,3'''<br />
A link [http://www.google.com Google]<br />
<br />
<br />
----<br />
<br />
----<br />
<br />
----<br />
<br />
----<br />
<br />
<br />
I have put in the following link that works:<br />
[[About Moodle]]<br />
<br />
'''I don't know''' ''what I'm doing.''<br />
<br />
Visit this site<br />
[http://www.midwiferytoday.com | Midwifery Today]<br />
<br />
[Manage_roles]<br />
<br />
<noinclude></noinclude>các bạn ơi vào đây lấy tài liệu Java<br />
<br />
My first '''sandbox''' attempt.<br />
<br />
test '''test''' [[test]]<br />
<br />
<br />
----<br />
dvnsedn<br />
<br />
[[Image:ndfcdnVC]]<br />
<br />
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><br />
<html><br />
<head><br />
<title>I know HTML at least</title><br />
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><br />
</head><br />
<br />
<body><br />
<p><strong>U1 Features &amp; Newswriting</strong></p><br />
<p align="center">&nbsp;</p><br />
<p align="center"><font size="3"><strong>Challenge </strong></font></p><br />
<p align="center"><img src="file:///C|/Documents%20and%20Settings/Owner/Desktop/print-media.jpg" width="150" height="181"></p><br />
<p align="center"><strong>Writing for the Media</strong></p><br />
<p align="left"><font size="3"><strong>Introduction</strong></font></p><br />
<p align="left"><strong><font size="2">Become an Inependent Learner</font></strong></p><br />
<p align="left"><font size="2">Online learning is a little different from being <br />
in the classroom. Working with the computer will challenge all your senses: <br />
thinking, speaking, seeing, hearing, touching, often all at the same time. We <br />
will begin with a topic you already know something about. In this case, writing <br />
for the media. Both of us will explore and expand your knowledge and experience <br />
of what it is like to be a reporter.</font></p><br />
<p align="left"><font size="2">Let's begin by exploring what we will learn in <br />
this unit.</font></p><br />
<p align="left"><font size="2"><strong>Objectives</strong></font></p><br />
<ul><br />
<li><font size="2">Review and practice keyboard skills</font></li><br />
<li><font size="2">Develop an article for your local newspaper</font></li><br />
<li><font size="2">Challenge your Grammar skills: Fragments.</font></li><br />
<li><font size="2">Record your progress: Journal Entry</font></li><br />
</ul><br />
<p align="left"><strong><font size="3" face="Verdana, Arial, Helvetica, sans-serif"> <br />
The Keyboard</font></strong></p><br />
<p align="center"><strong><img src="Keyboard.jpg" width="149" height="72"></strong></p><br />
<p align="center"><a href="TheKeyboard"><strong>The Keyboard</strong></a></p><br />
<ul><br />
<li><font size="2">Select the link and warm up your mind and fingers</font></li><br />
<li><font size="2">What about your <strong><a href="http://www.powertyping.com/qwerty/lessonsq.html">speed <br />
and accuracy?</a></strong></font></li><br />
</ul><br />
<p>&nbsp;</p><br />
<p><font size="3"><strong>Writing Skills</strong></font></p><br />
<p><strong><font size="2">Writing Articles for the Media</font></strong></p><br />
<br />
<ul><br />
<li><font size="2">What do the images below tell you about the difference between <br />
news writing and feature writing?</font></li><br />
<li><font size="2"><a href="http://teacher.scholastic.com/writewit/news/step1.htm"><strong>How <br />
would you describe each type?</strong></a></font></li><br />
</ul><br />
<p><strong><font size="2">News</font></strong></p><br />
<p><font size="2"><img src="front%20page.jpg" width="122" height="133"></font></p><br />
<p><strong><font size="2">5 W's Chart</font></strong></p><br />
<br />
<table width="49%" border="3"><br />
<tr><br />
<td><p><strong><font size="2">What happened?</font></strong></p><br />
<p>&nbsp;</p><br />
</td><br />
</tr><br />
<tr><br />
<td><p><strong><font size="2">Who was there?</font></strong></p><br />
<p>&nbsp;</p><br />
</td><br />
</tr><br />
<tr><br />
<td><p><strong><font size="2">Why did it happen?</font></strong></p><br />
<p>&nbsp;</p><br />
<p>&nbsp;</p></td><br />
</tr><br />
<tr><br />
<td><p><strong><font size="2">When did it happen?</font></strong></p><br />
<p>&nbsp;</p><br />
</td><br />
</tr><br />
<tr><br />
<td><p><strong><font size="2">Where did it happen?</font></strong></p><br />
<p>&nbsp;</p><br />
<p>&nbsp;</p></td><br />
</tr><br />
</table><br />
</p><br />
<p><strong><font size="2">Feature</font></strong></p><br />
<p><img src="SportsStar.jpg" width="116" height="140"></p><br />
<p> <strong><font size="2">Holds Readers' Attention</font></strong></p><br />
<ul><br />
<li><font size="2">Grab them or lose them!</font></li><br />
<li><font size="2">Get the right quote!</font></li><br />
<li><font size="2">Like a short story!</font></li><br />
<li><font size="2">Make your readers care!</font></li><br />
</ul><br />
<p><font size="2"><strong>Would you like to view a <a href="http://www.stonesoup.com/pdfs/stone_soup.pdf">student <br />
magazine?</a></strong></font></p><br />
<p>&nbsp;</p><br />
<p><strong>Grammar Skills</strong></p><br />
<p><strong><font size="2">How about a Quick Grammar Quiz?</font></strong></p><br />
<ul><br />
<li><font size="2">How can you recognize a<a href="http://www.quia.com/pop/13222.html?AP_rand=652226721"> <br />
<strong>fragment?</strong></a></font></li><br />
</ul><br />
<p><strong><font size="1">(Try for 10/10)</font></strong></p><br />
<ul><br />
<li><font size="2">Can you create sentences from fragments?</font></li><br />
<li><font size="2">Revise the fragments. </font></li><br />
</ul><br />
<p><font size="1"><strong>(Enter correct sentences to your Notes page.)</strong></font></p><br />
<p><img src="HappyFace.jpg" width="143" height="143"></p><br />
<p><strong>Congratulations!! </strong></p><br />
</body><br />
</html><br />
<br />
== Tracker autolinking ==<br />
<br />
MDL-19398 doesn't work. (yes, it does - now!) ;-)<br />
<br />
But now this doesn't: [http://tracker.moodle.org/browse/MDL-17284 tracker item desccription] --[[User:Olli Savolainen|Olli Savolainen]] 09:51, 6 June 2009 (UTC)<br />
:Fixed! --[[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 22:34, 9 June 2009 (UTC)<br />
<br />
What about this syntax? [[MDL-17284|tracker item desccription]] Doesn't work either. --[[User:Frank Ralf|Frank Ralf]] 20:08, 7 June 2009 (UTC)<br />
:And never has worked before AFAIK, it's the syntax used within Moodle (something like a "interwiki" link), but not within Moodle Docs (where it's an standard link to named page). --[[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 22:34, 9 June 2009 (UTC)<br />
:: Thanks for fixing this. The interwiki link was just a try, forget about it ;-) --[[User:Frank Ralf|Frank Ralf]] 14:34, 10 June 2009 (UTC)<br />
<br />
This one does: MDL-19398.<br />
<br />
And spaces in the text MDL-19398 also should be respected.<br />
:Fixed! --[[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 11:03, 23 June 2009 (UTC)<br />
<br />
And these:<br />
<br />
MDL-19398<br />
<br />
MDL-19398<br />
<br />
# MDL-19398 <br />
<br />
* MDL-19398<br />
<br />
== asdf ==<br />
'''Bold text'''<br />
<br />
External images not possible:<br />
http://henrik.nyh.se/images/pug.png<br />
[[Image:http://henrik.nyh.se/images/pug.png]]<br />
[[http://pilpi.net/photos/d/2946-2/11P1120874.JPG]]<br />
<br />
Another try:<br />
[http://pilpi.net/photos/d/2946-2/11P1120874.JPG]<br />
<br />
{{Work in progress}}<br />
<br />
{{Work in progress|info=<br /><br/>additional info<br />
<br />
wefahpo}}<br />
<br />
test<br />
<br />
<br />
== Image insertion test ==<br />
[[Image:Example.jpg]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Template:Game&diff=59770Template:Game2009-07-13T15:17:01Z<p>Cabeasley: </p>
<hr />
<div><div class="sideblock right" style="width: 12em;"><br />
<div class="header">[[Game module]]</div><br />
<div class="content"><br />
* [[Game_module_install|How to install]]<br />
* [[Game_module_configure|How to configure]]<br />
* [[Game_module_demo|References & Demo video]]<br />
* [[Game_module_developers|Info for developers]]<br />
* [[Game_module_howtohelp|How I can help?]]<br />
* [[Game_module_public|Publishes]]<br />
* [[Game_module_sites|Sites that uses it]]<br />
</div><br />
</div></div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Template:Game&diff=59769Template:Game2009-07-13T15:13:37Z<p>Cabeasley: </p>
<hr />
<div><div class="sideblock right" style="width: 12em;"><br />
<div class="header">[[Game module]]</div><br />
<div class="content"><br />
* [[Game_module_install|Installing the Game module]]<br />
* [[Game_module_configure|Configuring the Game module]]<br />
* [[ | ]]<br />
* [[ | ]]<br />
</div><br />
</div></div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Template:Game&diff=59768Template:Game2009-07-13T15:05:29Z<p>Cabeasley: </p>
<hr />
<div><div class="sideblock right" style="width: 12em;"><br />
<div class="header">[[Game module]]</div><br />
<div class="content"><br />
* [[Game module install|Installing the Game module]]<br />
* [[Adding Feedback questions|Adding questions]]<br />
* [[Viewing Feedback responses|Viewing responses]]<br />
* [[Feedback module FAQ|Feedback FAQ]]<br />
</div><br />
</div></div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Template:Game&diff=59767Template:Game2009-07-13T15:04:13Z<p>Cabeasley: </p>
<hr />
<div><div class="sideblock right" style="width: 12em;"><br />
<div class="header">[[Game module]]</div><br />
<div class="content"><br />
* [[Installing the Game module|Game module install]]<br />
* [[Adding Feedback questions|Adding questions]]<br />
* [[Viewing Feedback responses|Viewing responses]]<br />
* [[Feedback module FAQ|Feedback FAQ]]<br />
</div><br />
</div></div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module&diff=59766Game module2009-07-13T14:58:45Z<p>Cabeasley: </p>
<hr />
<div>{{Game}}<br />
<br />
This module contains 8 games and is translated to [https://docs.moodle.org/eu/Jolas_modulua Basque], Dutch, [https://docs.moodle.org/fr/Module_jeux Frence], [https://docs.moodle.org/el/Game_module Greek], Norwegian, Rusian, [https://docs.moodle.org/es/Game_module Spanish]<br />
<br />
==Available games==<br />
<br />
<br />
Glossary Questions<br />
Game True / False<br />
Short answer Multi choice<br />
Hangman X Χ<br />
Crossword X Χ<br />
Cryptex X Χ<br />
Millionaire Χ<br />
Sudoku X Χ Χ Χ<br />
The hidden picture X Χ Χ Χ<br />
Snakes and Ladders Χ Χ<br />
Book with questions X Χ Χ Χ<br />
<br />
=== Hangman===<br />
This game takes words from either a Glossary or quiz short answer questions and generates a hangman puzzle. Teacher can set the number of words that each game contains, if shows the first or last letter, or if show the question or the answer at the end.<br />
<br />
[[Image:Hangman.jpg]]<br />
<br />
===Crossword=== <br />
This game takes words from either a Glossary or quiz short answer questions and generates a random crossword puzzle. Teacher can set the maximum number of columns/rows or words that contains. Student can press the button “Check crossword” to check if the answers are correct. Every crossword is dynamic so it is different to every student.<br />
<br />
[[Image:Crossword.jpg]]<br />
<br />
=== Cryptex=== <br />
This game is like a crossword but the answers are hidden inside a random cryptex.<br />
<br />
[[Image:Cryptex.jpg]]<br />
<br />
===Millionaire=== <br />
This game takes words from multiple choice quiz questions and creates a “Who wants to be a Millionaire” style game complete with the three lifelines. <br />
<br />
[[Image:Millionaire.jpg]]<br />
<br />
====How to Play Millionaire====<br />
The rules of the Millionaire game are simple: you must answer each question correctly to proceed - if you answer one question wrong, the game is over. Look in the bottom-right corner of your screen to see if you answered the question correctly or not.<br />
<br />
To end or start a new game, click on the 'X' next to the lifelines (top of screen). You will be presented with a new page where you have two options: you can end the game and return to the course, or you can start a new game.<br />
<br />
=== Sudoku=== <br />
This game shows a sudoku puzzle to the students with not enough numbers to allow it to be solved. For each question the student correctly answers an additional number is slotted into the puzzle to make it easier to solve.<br />
<br />
[[Image:Sudoku.jpg]]<br />
<br />
=== The hidden picture=== <br />
This game randomly grabs an image from a glossary and hides it behind panels. As each question is answered correctly a portion of the image is revealed. How fast can they guess the image?<br />
<br />
[[Image:Hidden picture.jpg]]<br />
<br />
=== Snakes and Ladders=== <br />
The students have to traverse a traditional “Snakes and Ladders” board by answering questions taken from either a Glossary or quiz short answer questions. As they get an answer right, the dice is rolled and a random number displayed. The game piece is moved ahead that many squares. If the game piece is in the bottom of a ladder and the answer is correct, it goes to the top. If the game piece is in head of snake and the answer is wrong, it goes to the tail.<br />
<br />
[[Image:snakes_and_ladders.jpg]]<br />
<br />
=== Book with questions=== <br />
When the student answers correct can go to the next chapter.<br />
Source for each game<br />
<br />
<br />
<br />
==Other page links==<br />
=== How to install === <br />
[[Game_module_install|How to install]]<br />
=== How to configure === <br />
[[Game_module_configure|How to configure]]<br />
===Demo video and References===<br />
[[Game_module_demo|References & Demo video]] <br />
=== Info for developers === <br />
[[Game_module_developers|Info for developers]]<br />
=== How I can help? === <br />
[[Game_module_howtohelp|How I can help?]]<br />
=== Publishes === <br />
[[Game_module_public|Publishes]]<br />
=== Sites that uses it === <br />
[[Game_module_sites|Sites that uses it]]<br />
<br />
<br />
==See also==<br />
*[http://moodle.org/mod/data/view.php?d=13&rid=1196 Game]'s Module and Plugin database page<br />
*[http://download.moodle.org/plugins/mod/game.zip Download latest version]<br />
*[http://cvs.moodle.org/contrib/plugins/mod/game/ Browse CVS]<br />
*[http://tracker.moodle.org/browse/CONTRIB/component/10295 Bugs and Issues] at Tracker<br />
*[http://moodle.org/mod/forum/view.php?id=7220 Discussion in English] at Game Module Forum<br />
*[http://moodle.org/mod/forum/discuss.php?d=92033 Success stories of Module Game] at Game Module Forum<br />
*[http://moodle.org/mod/forum/discuss.php?d=92581 Suggest modes of educational exploitation] at Game Module Forum<br />
*[http://bdaloukas.gr/moodle Demo site] *[http://bdaloukas.gr/moodle/download/game/doc/game.swf Demo flash video]<br />
<br />
[[Category:Contributed code]]<br />
<br />
[[fr:Module jeux]]<br />
[[es:Game module]]<br />
[[el:Game module]]<br />
[[eu:Jolas modulua]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Template:Game&diff=59765Template:Game2009-07-13T14:58:24Z<p>Cabeasley: New page: <div class="sideblock right" style="width: 12em;"> <div class="header">Game module</div> <div class="content"> * Adding/editing a feedback form * [[Adding Feedback questions|Adding...</p>
<hr />
<div><div class="sideblock right" style="width: 12em;"><br />
<div class="header">[[Game module]]</div><br />
<div class="content"><br />
* [[Adding/editing a feedback form]]<br />
* [[Adding Feedback questions|Adding questions]]<br />
* [[Viewing Feedback responses|Viewing responses]]<br />
* [[Feedback module FAQ|Feedback FAQ]]<br />
</div><br />
</div></div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Development:Setting_up_Eclipse&diff=59663Development:Setting up Eclipse2009-07-10T13:05:20Z<p>Cabeasley: /* Web and XML settings */</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
Since this page was written, Eclipse 3.3 and 3.4 have been released, along with a new PHP plugin called PDT, which is better, but uses more memory. You can download an all-in-one Eclipse+PDT from http://www.eclipse.org/pdt/downloads/. The following instructions, from the section [[#Setting_the_preferences_for_Moodle_development]] mostly still apply after you have done the install, but some of the details are a bit different.--[[User:Tim Hunt|Tim Hunt]] 07:30, 31 January 2009 (CST)<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it creates a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step. (On Eclipse 3.4.0 on OSX this is in '''Eclipse > Preferences > General > Network Connections''')<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://update.phpeclipse.net/update/nightly; then click '''OK'''. Click '''Finish'''. Under '''PHPEclipse Nightly Builds''', check '''PHPeclipse'''. Click '''Finish'''. Wait while it downloads (this may take a few minutes). Click '''Install'''. You will be prompted to restart Eclipse, click '''Restart'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Restart the wizard (from the '''Help''' menu choose '''Software Updates -> Find and Install'''). <br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
Select just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site''').<br />
Then click '''Finish'''.<br />
<br />
It goes off and sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want (Select the features to install). The ones you want (you may have to expand and search the tree structure) are: all the '''PHPEclipse Nightly Builds''' (from your newly created PHPEclipse Update Site) and the '''Web Standard Tools (WST)''' (usually under Callisto or Europa Discovery Site --> Web and J2EE Development). <br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation built digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box (use the '''Default''' button - the default will appear at the top of the list). <br />
<br />
With '''*.html''' selected in the top box, if it is not already there, add '''PHP Editor''' to the bottom box. Then select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Network Connections'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
Under '''General -> Editors -> Text Editors''', check '''Show line numbers''' to display line numbers in the left margin (optional). Click '''Apply'''. (When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.)<br />
<br />
Under '''PHPeclipse -> Browser Preview Defaults''', turn off all checkboxes (if necessary). Click "Apply".<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4 (if necessary). Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Editor''', turn on '''Remove trailing spaces on editor save'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS''', on the '''Files and Folders''' tab, set '''Default text mode''' to '''ASCII with keyword expansion (-kkv)'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
For each XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XML Files -> Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-highlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should find that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project...''' That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all of the really important features. I'm sure you can learn everything else on your own. And you can always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right-click an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right-click an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. Right-click it and expand configure branches and versions.<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. Select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. Locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update, I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
<br />
[[Category:Developer|Eclipse]]<br />
[[Category:Developer tools|Eclipse]]<br />
<br />
[[fr:Développement:Eclipse]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Development:Setting_up_Eclipse&diff=59662Development:Setting up Eclipse2009-07-10T13:03:45Z<p>Cabeasley: /* Web and XML settings */</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
Since this page was written, Eclipse 3.3 and 3.4 have been released, along with a new PHP plugin called PDT, which is better, but uses more memory. You can download an all-in-one Eclipse+PDT from http://www.eclipse.org/pdt/downloads/. The following instructions, from the section [[#Setting_the_preferences_for_Moodle_development]] mostly still apply after you have done the install, but some of the details are a bit different.--[[User:Tim Hunt|Tim Hunt]] 07:30, 31 January 2009 (CST)<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it creates a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step. (On Eclipse 3.4.0 on OSX this is in '''Eclipse > Preferences > General > Network Connections''')<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://update.phpeclipse.net/update/nightly; then click '''OK'''. Click '''Finish'''. Under '''PHPEclipse Nightly Builds''', check '''PHPeclipse'''. Click '''Finish'''. Wait while it downloads (this may take a few minutes). Click '''Install'''. You will be prompted to restart Eclipse, click '''Restart'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Restart the wizard (from the '''Help''' menu choose '''Software Updates -> Find and Install'''). <br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
Select just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site''').<br />
Then click '''Finish'''.<br />
<br />
It goes off and sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want (Select the features to install). The ones you want (you may have to expand and search the tree structure) are: all the '''PHPEclipse Nightly Builds''' (from your newly created PHPEclipse Update Site) and the '''Web Standard Tools (WST)''' (usually under Callisto or Europa Discovery Site --> Web and J2EE Development). <br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation built digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box (use the '''Default''' button - the default will appear at the top of the list). <br />
<br />
With '''*.html''' selected in the top box, if it is not already there, add '''PHP Editor''' to the bottom box. Then select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Network Connections'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
Under '''General -> Editors -> Text Editors''', check '''Show line numbers''' to display line numbers in the left margin (optional). Click '''Apply'''. (When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.)<br />
<br />
Under '''PHPeclipse -> Browser Preview Defaults''', turn off all checkboxes (if necessary). Click "Apply".<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4 (if necessary). Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Editor''', turn on '''Remove trailing spaces on editor save'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS''', on the '''Files and Folders''' tab, set '''Default text mode''' to '''ASCII with keyword expansion (-kkv)'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
For each XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XXX Files -> XXX Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-highlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should find that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project...''' That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all of the really important features. I'm sure you can learn everything else on your own. And you can always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right-click an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right-click an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. Right-click it and expand configure branches and versions.<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. Select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. Locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update, I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
<br />
[[Category:Developer|Eclipse]]<br />
[[Category:Developer tools|Eclipse]]<br />
<br />
[[fr:Développement:Eclipse]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Development:Setting_up_Eclipse&diff=59661Development:Setting up Eclipse2009-07-10T13:02:45Z<p>Cabeasley: /* PHP Settings */</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
Since this page was written, Eclipse 3.3 and 3.4 have been released, along with a new PHP plugin called PDT, which is better, but uses more memory. You can download an all-in-one Eclipse+PDT from http://www.eclipse.org/pdt/downloads/. The following instructions, from the section [[#Setting_the_preferences_for_Moodle_development]] mostly still apply after you have done the install, but some of the details are a bit different.--[[User:Tim Hunt|Tim Hunt]] 07:30, 31 January 2009 (CST)<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it creates a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step. (On Eclipse 3.4.0 on OSX this is in '''Eclipse > Preferences > General > Network Connections''')<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://update.phpeclipse.net/update/nightly; then click '''OK'''. Click '''Finish'''. Under '''PHPEclipse Nightly Builds''', check '''PHPeclipse'''. Click '''Finish'''. Wait while it downloads (this may take a few minutes). Click '''Install'''. You will be prompted to restart Eclipse, click '''Restart'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Restart the wizard (from the '''Help''' menu choose '''Software Updates -> Find and Install'''). <br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
Select just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site''').<br />
Then click '''Finish'''.<br />
<br />
It goes off and sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want (Select the features to install). The ones you want (you may have to expand and search the tree structure) are: all the '''PHPEclipse Nightly Builds''' (from your newly created PHPEclipse Update Site) and the '''Web Standard Tools (WST)''' (usually under Callisto or Europa Discovery Site --> Web and J2EE Development). <br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation built digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box (use the '''Default''' button - the default will appear at the top of the list). <br />
<br />
With '''*.html''' selected in the top box, if it is not already there, add '''PHP Editor''' to the bottom box. Then select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Network Connections'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
Under '''General -> Editors -> Text Editors''', check '''Show line numbers''' to display line numbers in the left margin (optional). Click '''Apply'''. (When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.)<br />
<br />
Under '''PHPeclipse -> Browser Preview Defaults''', turn off all checkboxes (if necessary). Click "Apply".<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4 (if necessary). Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Editor''', turn on '''Remove trailing spaces on editor save'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS''', on the '''Files and Folders''' tab, set '''Default text mode''' to '''ASCII with keyword expansion (-kkv)'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
Foreach XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XXX Files ->XXX Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-highlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should find that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project...''' That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all of the really important features. I'm sure you can learn everything else on your own. And you can always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right-click an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right-click an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. Right-click it and expand configure branches and versions.<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. Select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. Locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update, I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
<br />
[[Category:Developer|Eclipse]]<br />
[[Category:Developer tools|Eclipse]]<br />
<br />
[[fr:Développement:Eclipse]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Development:Setting_up_Eclipse&diff=59660Development:Setting up Eclipse2009-07-10T12:55:59Z<p>Cabeasley: /* PHP Settings */</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
Since this page was written, Eclipse 3.3 and 3.4 have been released, along with a new PHP plugin called PDT, which is better, but uses more memory. You can download an all-in-one Eclipse+PDT from http://www.eclipse.org/pdt/downloads/. The following instructions, from the section [[#Setting_the_preferences_for_Moodle_development]] mostly still apply after you have done the install, but some of the details are a bit different.--[[User:Tim Hunt|Tim Hunt]] 07:30, 31 January 2009 (CST)<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it creates a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step. (On Eclipse 3.4.0 on OSX this is in '''Eclipse > Preferences > General > Network Connections''')<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://update.phpeclipse.net/update/nightly; then click '''OK'''. Click '''Finish'''. Under '''PHPEclipse Nightly Builds''', check '''PHPeclipse'''. Click '''Finish'''. Wait while it downloads (this may take a few minutes). Click '''Install'''. You will be prompted to restart Eclipse, click '''Restart'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Restart the wizard (from the '''Help''' menu choose '''Software Updates -> Find and Install'''). <br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
Select just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site''').<br />
Then click '''Finish'''.<br />
<br />
It goes off and sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want (Select the features to install). The ones you want (you may have to expand and search the tree structure) are: all the '''PHPEclipse Nightly Builds''' (from your newly created PHPEclipse Update Site) and the '''Web Standard Tools (WST)''' (usually under Callisto or Europa Discovery Site --> Web and J2EE Development). <br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation built digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box (use the '''Default''' button - the default will appear at the top of the list). <br />
<br />
With '''*.html''' selected in the top box, if it is not already there, add '''PHP Editor''' to the bottom box. Then select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Network Connections'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
Under '''PHPeclipse -> Browser Preview Defaults''', turn off all checkboxes (if necessary).<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4 (if necessary).<br />
<br />
Under '''General -> Editors -> Text Editors''', check '''Show line numbers''' to display line numbers in the left margin (optional). NOTE: When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.<br />
<br />
Under '''PHPeclipse -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Editor''', turn on '''Remove trailing spaces on editor save'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''. Click '''Apply'''.<br />
<br />
Under '''PHPeclipse -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS''', on the '''Files and Folders''' tab, set '''Default text mode''' to '''ASCII with keyword expansion (-kkv)'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
Foreach XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XXX Files ->XXX Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-highlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should find that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project...''' That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all of the really important features. I'm sure you can learn everything else on your own. And you can always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right-click an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right-click an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. Right-click it and expand configure branches and versions.<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. Select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. Locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update, I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
<br />
[[Category:Developer|Eclipse]]<br />
[[Category:Developer tools|Eclipse]]<br />
<br />
[[fr:Développement:Eclipse]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Development:Setting_up_Eclipse&diff=59659Development:Setting up Eclipse2009-07-10T12:34:07Z<p>Cabeasley: /* General settings */</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
Since this page was written, Eclipse 3.3 and 3.4 have been released, along with a new PHP plugin called PDT, which is better, but uses more memory. You can download an all-in-one Eclipse+PDT from http://www.eclipse.org/pdt/downloads/. The following instructions, from the section [[#Setting_the_preferences_for_Moodle_development]] mostly still apply after you have done the install, but some of the details are a bit different.--[[User:Tim Hunt|Tim Hunt]] 07:30, 31 January 2009 (CST)<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it creates a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step. (On Eclipse 3.4.0 on OSX this is in '''Eclipse > Preferences > General > Network Connections''')<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://update.phpeclipse.net/update/nightly; then click '''OK'''. Click '''Finish'''. Under '''PHPEclipse Nightly Builds''', check '''PHPeclipse'''. Click '''Finish'''. Wait while it downloads (this may take a few minutes). Click '''Install'''. You will be prompted to restart Eclipse, click '''Restart'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Restart the wizard (from the '''Help''' menu choose '''Software Updates -> Find and Install'''). <br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
Select just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site''').<br />
Then click '''Finish'''.<br />
<br />
It goes off and sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want (Select the features to install). The ones you want (you may have to expand and search the tree structure) are: all the '''PHPEclipse Nightly Builds''' (from your newly created PHPEclipse Update Site) and the '''Web Standard Tools (WST)''' (usually under Callisto or Europa Discovery Site --> Web and J2EE Development). <br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation built digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box (use the '''Default''' button - the default will appear at the top of the list). <br />
<br />
With '''*.html''' selected in the top box, if it is not already there, add '''PHP Editor''' to the bottom box. Then select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Network Connections'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
These are all hidden under the '''PHPeclipse Web Development''' bit of the tree.<br />
<br />
Under '''PHPeclipse Web Development -> Browser Preview Defaults''', turn off both checkboxes.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, check '''Show line numbers''' to display line numbers in the left margin (optional). NOTE: When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments''' and '''Remove trailing spaces on editor save'''. It would be nice to turn on more of these options, but most of the rest don't work very well.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse Web Development -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS''', on the '''Files and Folders''' tab, set '''Default text mode''' to '''ASCII with keyword expansion (-kkv)'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
Foreach XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XXX Files ->XXX Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-highlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should find that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project...''' That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all of the really important features. I'm sure you can learn everything else on your own. And you can always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right-click an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right-click an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. Right-click it and expand configure branches and versions.<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. Select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. Locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update, I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
<br />
[[Category:Developer|Eclipse]]<br />
[[Category:Developer tools|Eclipse]]<br />
<br />
[[fr:Développement:Eclipse]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Development:Setting_up_Eclipse&diff=59658Development:Setting up Eclipse2009-07-10T12:33:19Z<p>Cabeasley: /* General settings */</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
Since this page was written, Eclipse 3.3 and 3.4 have been released, along with a new PHP plugin called PDT, which is better, but uses more memory. You can download an all-in-one Eclipse+PDT from http://www.eclipse.org/pdt/downloads/. The following instructions, from the section [[#Setting_the_preferences_for_Moodle_development]] mostly still apply after you have done the install, but some of the details are a bit different.--[[User:Tim Hunt|Tim Hunt]] 07:30, 31 January 2009 (CST)<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it creates a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step. (On Eclipse 3.4.0 on OSX this is in '''Eclipse > Preferences > General > Network Connections''')<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://update.phpeclipse.net/update/nightly; then click '''OK'''. Click '''Finish'''. Under '''PHPEclipse Nightly Builds''', check '''PHPeclipse'''. Click '''Finish'''. Wait while it downloads (this may take a few minutes). Click '''Install'''. You will be prompted to restart Eclipse, click '''Restart'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Restart the wizard (from the '''Help''' menu choose '''Software Updates -> Find and Install'''). <br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
Select just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site''').<br />
Then click '''Finish'''.<br />
<br />
It goes off and sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want (Select the features to install). The ones you want (you may have to expand and search the tree structure) are: all the '''PHPEclipse Nightly Builds''' (from your newly created PHPEclipse Update Site) and the '''Web Standard Tools (WST)''' (usually under Callisto or Europa Discovery Site --> Web and J2EE Development). <br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation built digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box (use the '''Default''' button - the default will appear at the top of the list). <br />
<br />
With '''*.html''' selected in the top box, if it is not already there, add '''PHP Editor''' to the bottom box. Then select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Network Connections'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
Click '''OK'''.<br />
<br />
===PHP Settings===<br />
<br />
These are all hidden under the '''PHPeclipse Web Development''' bit of the tree.<br />
<br />
Under '''PHPeclipse Web Development -> Browser Preview Defaults''', turn off both checkboxes.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, check '''Show line numbers''' to display line numbers in the left margin (optional). NOTE: When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments''' and '''Remove trailing spaces on editor save'''. It would be nice to turn on more of these options, but most of the rest don't work very well.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse Web Development -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS''', on the '''Files and Folders''' tab, set '''Default text mode''' to '''ASCII with keyword expansion (-kkv)'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
Foreach XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XXX Files ->XXX Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-highlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should find that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project...''' That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all of the really important features. I'm sure you can learn everything else on your own. And you can always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right-click an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right-click an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. Right-click it and expand configure branches and versions.<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. Select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. Locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update, I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
<br />
[[Category:Developer|Eclipse]]<br />
[[Category:Developer tools|Eclipse]]<br />
<br />
[[fr:Développement:Eclipse]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Development:Setting_up_Eclipse&diff=59657Development:Setting up Eclipse2009-07-10T12:11:16Z<p>Cabeasley: /* Installing the necessary plugins */</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
Since this page was written, Eclipse 3.3 and 3.4 have been released, along with a new PHP plugin called PDT, which is better, but uses more memory. You can download an all-in-one Eclipse+PDT from http://www.eclipse.org/pdt/downloads/. The following instructions, from the section [[#Setting_the_preferences_for_Moodle_development]] mostly still apply after you have done the install, but some of the details are a bit different.--[[User:Tim Hunt|Tim Hunt]] 07:30, 31 January 2009 (CST)<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it creates a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step. (On Eclipse 3.4.0 on OSX this is in '''Eclipse > Preferences > General > Network Connections''')<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://update.phpeclipse.net/update/nightly; then click '''OK'''. Click '''Finish'''. Under '''PHPEclipse Nightly Builds''', check '''PHPeclipse'''. Click '''Finish'''. Wait while it downloads (this may take a few minutes). Click '''Install'''. You will be prompted to restart Eclipse, click '''Restart'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Restart the wizard (from the '''Help''' menu choose '''Software Updates -> Find and Install'''). <br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
Select just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site''').<br />
Then click '''Finish'''.<br />
<br />
It goes off and sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want (Select the features to install). The ones you want (you may have to expand and search the tree structure) are: all the '''PHPEclipse Nightly Builds''' (from your newly created PHPEclipse Update Site) and the '''Web Standard Tools (WST)''' (usually under Callisto or Europa Discovery Site --> Web and J2EE Development). <br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation built digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box. With '''*.html''' selected in the top box, select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Internet -> Proxy Settings'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
These are all hidden under the '''PHPeclipse Web Development''' bit of the tree.<br />
<br />
Under '''PHPeclipse Web Development -> Browser Preview Defaults''', turn off both checkboxes.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, check '''Show line numbers''' to display line numbers in the left margin (optional). NOTE: When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments''' and '''Remove trailing spaces on editor save'''. It would be nice to turn on more of these options, but most of the rest don't work very well.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse Web Development -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS''', on the '''Files and Folders''' tab, set '''Default text mode''' to '''ASCII with keyword expansion (-kkv)'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
Foreach XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XXX Files ->XXX Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-highlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should find that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project...''' That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all of the really important features. I'm sure you can learn everything else on your own. And you can always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right-click an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right-click an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. Right-click it and expand configure branches and versions.<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. Select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. Locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update, I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
<br />
[[Category:Developer|Eclipse]]<br />
[[Category:Developer tools|Eclipse]]<br />
<br />
[[fr:Développement:Eclipse]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Development:Setting_up_Eclipse&diff=59655Development:Setting up Eclipse2009-07-10T11:57:35Z<p>Cabeasley: /* Installing the necessary plugins */</p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
Since this page was written, Eclipse 3.3 and 3.4 have been released, along with a new PHP plugin called PDT, which is better, but uses more memory. You can download an all-in-one Eclipse+PDT from http://www.eclipse.org/pdt/downloads/. The following instructions, from the section [[#Setting_the_preferences_for_Moodle_development]] mostly still apply after you have done the install, but some of the details are a bit different.--[[User:Tim Hunt|Tim Hunt]] 07:30, 31 January 2009 (CST)<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it creates a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step. (On Eclipse 3.4.0 on OSX this is in '''Eclipse > Preferences > General > Network Connections''')<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://update.phpeclipse.net/update/nightly; then click '''OK'''. Click '''Finish'''. Under '''PHPEclipse Nightly Builds''', check '''PHPeclipse'''. Click '''Finish'''. Wait while it downloads (this may take a few minutes). Click '''Install'''. You will be prompted to restart Eclipse, click '''Restart'''.<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Back in the wizard, turn on just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site''').<br />
Then click '''Finish'''.<br />
<br />
It goes off and sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want. The ones you want (you may have to search the tree structure) are: '''PHPeclipse''' (from your newly created PHPEclipse Update Site) and all the '''Web Standard Tools (WST)''' (usually under Callisto Discovery Site --> Web and J2EE Development).<br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation built digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box. With '''*.html''' selected in the top box, select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Internet -> Proxy Settings'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
These are all hidden under the '''PHPeclipse Web Development''' bit of the tree.<br />
<br />
Under '''PHPeclipse Web Development -> Browser Preview Defaults''', turn off both checkboxes.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, check '''Show line numbers''' to display line numbers in the left margin (optional). NOTE: When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments''' and '''Remove trailing spaces on editor save'''. It would be nice to turn on more of these options, but most of the rest don't work very well.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse Web Development -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS''', on the '''Files and Folders''' tab, set '''Default text mode''' to '''ASCII with keyword expansion (-kkv)'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
Foreach XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XXX Files ->XXX Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-highlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should find that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project...''' That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all of the really important features. I'm sure you can learn everything else on your own. And you can always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right-click an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right-click an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. Right-click it and expand configure branches and versions.<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. Select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. Locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update, I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
<br />
[[Category:Developer|Eclipse]]<br />
[[Category:Developer tools|Eclipse]]<br />
<br />
[[fr:Développement:Eclipse]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Development:Setting_up_Eclipse&diff=59653Development:Setting up Eclipse2009-07-10T11:33:58Z<p>Cabeasley: </p>
<hr />
<div>[http://www.eclipse.org/ Eclipse] is an IDE originally designed for Java, but now with plugins for many languages including PHP. It has lots of very powerful features, and it is the editor that some Moodle developers like to use. Other (more) popular choices are vim and emacs.<br />
<br />
However, Eclipse is not the easiest program in the world to get started with, so I'm going to take you through it step by step. These instructions assume Eclipse 3.2, the current version at the time of writing. It should not change much between releases.<br />
<br />
This article started off as a brain-dump by [[User:Tim Hunt|Tim Hunt]]. Since then, several other people have worked through it and made corrections, so the information here should be pretty accurate.<br />
<br />
Since this page was written, Eclipse 3.3 and 3.4 have been released, along with a new PHP plugin called PDT, which is better, but uses more memory. You can download an all-in-one Eclipse+PDT from http://www.eclipse.org/pdt/downloads/. The following instructions, from the section [[#Setting_the_preferences_for_Moodle_development]] mostly still apply after you have done the install, but some of the details are a bit different.--[[User:Tim Hunt|Tim Hunt]] 07:30, 31 January 2009 (CST)<br />
<br />
==Prerequisites==<br />
<br />
Eclipse is written in Java, so I recommend getting the latest Java runtime environment from http://java.com/ for maximum speed and reliability.<br />
<br />
Eclipse is quite big, so I recommend lots of memory in your computer. I have used it on Windows, MacOS X and Linux, in each case with 1GB of memory, and that is plenty.<br />
<br />
==Installing Eclipse==<br />
<br />
Go to http://www.eclipse.org/downloads/. Click on the link corresponding to your operating system where it says '''Eclipse Classic'''. Choose a Mirror, and wait for the ~100MB download.<br />
<br />
You will notice that what you have got is a zip file (unless your system automatically decompresses it for you).<br />
<br />
On Windows, unzip it into '''C:\Program Files''' (all the files go into an '''Eclipse''' folder there). Then look in the Eclipse folder and drag Eclipse.exe to the Start menu/Desktop/Quicklaunch bar to make a shortcut for starting it.<br />
<br />
On MacOS, unzip and copy the Eclipse folder into Applications. Go into the Eclipse folder and drag the Eclipse app to the Dock for ease of launching.<br />
<br />
On Linux, unzip somewhere suitable, and make an easy way to launch it.<br />
<br />
==The first time you run Eclipse==<br />
<br />
The first time you launch Eclipse it does a bit of setup stuff, for instance, it creates a '''workspace'''. This is where it stores the things you are working on. The default location is sensible on all platforms, so use that. <br />
<br />
For some reason, every time you start Eclipse, it asks you which workspace you want to use. I have never seen the need to have more than one, so I recommend turning on the checkbox that says "Use this as the default and do not ask again".<br />
<br />
Another thing that happens the first time you run Eclipse is that you arrive at a welcome screen. This has links to various bits of help, which you can read if you like, but you probably don't need to if you are following these instructions. So find the button on the welcome page that closes it and gets you to the main Eclipse screen.<br />
<br />
==Installing the necessary plugins==<br />
<br />
By default, Eclipse comes with the Java tools. For everything else you will need to install some plugins.<br />
<br />
If you are sitting behind a web proxy, from the '''Window''' menu choose '''Preferences ...'''. Choose '''Install/Update''' from the tree view on the left, and enter the proxy information in the boxes on the right. If you aren't behind a proxy, ignore this step. (On Eclipse 3.4.0 on OSX this is in '''Eclipse > Preferences > General > Network Connections''')<br />
<br />
From the '''Help''' menu choose '''Software Updates -> Find and Install'''.<br />
<br />
On the first screen of the wizard, make sure that "Search for new features to install" is selected, then click '''Next >'''.<br />
<br />
The next screen is a list of upgrade sites to check. You need to add one to the list, so click the '''New Remote Site ...''' Button.<br />
<br />
In the pop-up dialog, give the remote site a name like '''PHPeclipse Update Site'''; set the URL to http://update.phpeclipse.net/update/nightly; then click '''OK'''. Under '''PHPEclipse Stable Builds''', check '''PHPeclipse'''<br />
<br />
''Note, there is now also another PHP editor for Eclipse. The update URL ishttp://download.eclipse.org/tools/pdt/updates/. I am just trying it--[[User:Tim Hunt|Tim Hunt]] 11:39, 7 November 2007 (CST)''<br />
<br />
Back in the wizard, turn on just two things in the box "Sites to include in search":<br />
* Your newly created '''Phpeclipse Update Site'''; and<br />
* the one called '''Europa Discovery Site''' (or possibly '''Callisto Discovery Site''').<br />
Then click '''Finish'''.<br />
<br />
It goes off and sees what updates are available at those sites. As it does so, it may occasionally pop up a dialog asking you to choose a mirror. Each time, select a sensible one.<br />
<br />
Eventually, you get to a new wizard for selecting and installing the updates you want. The ones you want (you may have to search the tree structure) are: '''PHPeclipse''' (from your newly created PHPEclipse Update Site) and all the '''Web Standard Tools (WST)''' (usually under Callisto Discovery Site --> Web and J2EE Development).<br />
<br />
Next, and very importantly, you must click the '''Select Required''' button which should resolve dependencies and remove the warning message you are probably worrying about. Then you can click the '''Next >''' button.<br />
<br />
Read and agree to all the license agreements. Then click '''Next >'''. <br />
<br />
Click '''Finish''', and wait for the plugins to download.<br />
<br />
Once the downloads have finished, a warning will pop-up telling you that all the plugins you downloaded are not digitally signed. The Eclipse Foundation built digital signing of plugins into their architecture as a security measure, and then did not sign any of their own plugins! Anyway, click the '''Install All''' button.<br />
<br />
Finally, a window will pop up asking you to restart Eclipse. Do so.<br />
<br />
==Setting the preferences for Moodle development==<br />
<br />
Now go to the '''Window''' menu, and choose '''Preferences ...''' ('''Eclipse''' menu on Mac OS X).<br />
<br />
The Eclipse preferences are immense, with a tree view on the left, which selects which screen to display on the right. Don't panic, we'll guide you through it.<br />
<br />
===General settings===<br />
<br />
If you have strong feelings about fonts (I would hate to edit code an anything except Andale Mono), choose '''General -> Appearance -> Colors and Fonts''' from the tree on the left. Then on the right look under '''Basic''' and change '''Text Font'''. All the other editor font settings will inherit from this, so this is probably the only one you have to change.<br />
<br />
Under '''General -> Content Types''', select PHP Source File, and add '''*.html''' to the box at the bottom.<br />
<br />
Under '''General -> Editors -> File Associations''', if it is not already there, add '''*.php''' to the top box. With '''*.php''' selected in the top box, make sure '''PHP Editor''' is set to default in the bottom box. With '''*.html''' selected in the top box, select '''PHP Editor''' in the bottom box and click the '''Default''' button to change it, because in Moodle, most HTML files actually contain PHP code.<br />
<br />
If you use a web proxy, enter the details under '''Internet -> Proxy Settings'''. (Yes, I know you have entered them somewhere else before. Now you have to enter them again here. I don't know why. You just do.)<br />
<br />
===PHP Settings===<br />
<br />
These are all hidden under the '''PHPeclipse Web Development''' bit of the tree.<br />
<br />
Under '''PHPeclipse Web Development -> Browser Preview Defaults''', turn off both checkboxes.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, set '''Displayed tab width''' to 4.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Appearance''' tab, check '''Show line numbers''' to display line numbers in the left margin (optional). NOTE: When you are editing a PHP file, you could left-click in the left margin and tick the '''Show Line Numbers''' line in the contextual menu. However, this toggle only applies to plain text files, ''not'' to HTML or PHP files. The only place where you can toggle line numbers on/off for such files is in the PHP/Appearance menu.<br />
<br />
Under '''PHPeclipse Web Development -> PHP''', on the '''Typing''' tab, turn off all the options except '''Pasting for correct indentation''', '''Insert spaces for tab''' and '''Close PHPdocs and comments''' and '''Remove trailing spaces on editor save'''. It would be nice to turn on more of these options, but most of the rest don't work very well.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''New Lines''' tab, turn on '''Clear all blank lines'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Formatter''', on the '''Style''' tab, turn off '''Indentation is represented by a tab'''.<br />
<br />
Under '''PHPeclipse Web Development -> PHP -> Templates''', I like to define a new template to help with debugging:<br />
;Name<br />
:dump <br />
;Description<br />
:Dump a PHP variable<br />
;Pattern<br />
<pre>print_object(${word_selection}${cursor}); // DONOTCOMMIT</pre><br />
You can do other useful things with templates too. Here are two more I use:<br />
<pre>debugging("'${word_selection}${cursor}'"); // DONOTCOMMIT</pre><br />
<pre>$$string['${word_selection}${cursor}'] = '.';</pre><br />
That is, a simple debug message with a stack trace, and a new language string.<br />
<br />
There is a really stupid bug. Under '''PHPeclipse Web Development -> Project Defaults''', you would like to add "." to the '''Include Paths''', but you can't using the GUI. You will have to edit one of the Eclipse config files by hand. So<br />
# Note down the path to your Eclipse profile. On Windows it will be something like '''C:/Documents and settings/XXXX/workspace''', and on Unixy systems something like '''~/workspace'''.<br />
# Close Eclipse. <br />
# Open the file '''net.sourceforge.phpeclipse.ui.prefs''' that is in the directory '''(your workspace)/.metadata/.plugins/org.eclipse.core.runtime/.settings''' in a text editor.<br />
# Look for a line in the file that starts '''_php_include_paths=''' If it is not there, add it at the end.<br />
# Change this line to say '''_php_include_paths=.'''<br />
# Run Eclipse again.<br />
<br />
===SSH2===<br />
Information about generating SSH2 keys for the purpose of connecting to cvs.moodle.org can be found here at https://docs.moodle.org/en/Development:SSH_key , but please finish reading this section before reading that material.<br />
<br />
The Eclipse installation has its own SSH client plugin so you do not have to use a separate ssh client in connection with your use of Eclipse (this is one reason you will be using extssh below, instead of just ext, however, if you wish you may alter the configuration to use an external client but please post news of your success and configuration). See, http://www.jcraft.com/eclipse-cvsssh2/ , for additional information on this plugin. <br />
<br />
'' Since Eclipse 3.0M6 the CVSSSH plugin is incorporated into Eclipse, [http://www.jroller.com/prane/entry/eclipse_3_0_cvs_support as "extssh" instead of "extssh2"] - --[[User:Olli Savolainen|Olli Savolainen]] 07:54, 23 June 2008 (CDT)''<br />
<br />
Please note that Eclipse is fully equipped to generate ssh2 rsa and dsa keys as well as import keys. You may encounter issues with passphrases that are too long (a bug reportedly fixed but which may still in fact be present) and some issues with using keypairs generated by other applications have been seen, so it may be best to generate a key pair with Eclipse. Additional details on how to do this will be added.<br />
<br />
Sourceforge, at http://sourceforge.net/docs/F02/ , provides instructions on how to create a SSH key for it's CVS (remember, Moodle does not use sourceforge for its CVS now and you will need to generate keys for cvs.moodle.org, not sourceforge). This is mentioned by way of general explanation, not for the purposes of providing instructions on how to generate your keys for Eclipse. To make use of the public key, login to Moodle.org and add it via the Update My Developer Information tab under CVS Developers (http://moodle.org/cvs). Remember, public keys provided to Moodle must be in the Openssh format.<br />
<br />
===CVS Settings===<br />
<br />
These are almost all hidden under the '''Team''' bit of the tree.<br />
<br />
Under '''General -> Network Connections -> SSH2 -> Key Management''', you can set up a public/private key pair. If you do this, you won't have to keep typing your password when doing CVS operations. <br />
<br />
The rest of the ones in this section are personal preferences, but I recommend them because the default settings are very irritating.<br />
<br />
Under '''Team''', set '''Perspectives''' to '''None'''.<br />
<br />
Under '''Team -> CVS''', on the '''Files and Folders''' tab, set '''Default text mode''' to '''ASCII with keyword expansion (-kkv)'''.<br />
<br />
Under '''Team -> CVS -> Annotate''' set '''Use Quick Diff annotate mode for local file annotations''' to '''Yes''', and '''Open perspective after a 'Show Annotations' operation''' to '''No'''.<br />
<br />
Under '''Team -> CVS -> Label Decorations''', switch to the '''Icon Decorations''' tab and turn on all the settings, and then on the '''Text Decorations''' tab change both '''File Decoration''' and '''Folder Decoration''' to be just '''{name}'''.<br />
<br />
===Web and XML settings===<br />
<br />
Foreach XXX in CSS, HTML, Javascript, XML:<br />
<br />
Under '''Web and XML -> XXX Files ->XXX Source''', choose '''Indent using spaces''' and '''indentation size''' 4.<br />
<br />
==Checking out the Moodle code==<br />
<br />
From the '''File''' menu, choose '''New -> Project ...'''.<br />
<br />
In the wizard that pops up, choose '''CVS -> Projects from CVS''', then click '''Next >'''.<br />
<br />
Select '''Create a new repository location''', then click '''Next >'''.<br />
<br />
Fill in<br />
<div style="float: right; border: 1px solid orange; padding: 0 1em;"><br />
For anonymous CVS access use<br />
;Host<br />
:XX.cvs.moodle.org<br />
where XX.cvs.moodle.org is one of [[CVS_for_Administrators#CVS_Servers|these mirrors]]<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:anonymous<br />
;Password<br />
:(leave blank)<br />
;Connection type<br />
:pserver<br />
</div><br />
;Host<br />
:cvs.moodle.org<br />
;Repository path<br />
:/cvsroot/moodle<br />
;User<br />
:(your Moodle CVS username)<br />
;Password<br />
:(if you set up the SSH2 key thing in preferences, leave this blank, otherwise, type in your Moodle CVS password.)<br />
;Connection type<br />
:extssh<br />
(CVS experts, if you are confused by that last one, know it is an Eclipse-specific thing.) Then click '''Next >'''.<br />
<br />
On the next screen of the Wizard, choose '''Use an existing module'''. Wait a moment, then select '''moodle''' from the list. Click '''Next >'''.<br />
<br />
On the next screen, make sure the option '''Check out as a project configured using the New Project Wizard''' is selected, then click '''Next >'''.<br />
<br />
Click '''Refresh Tags''', then choose the branch you want. For now leave it set to '''HEAD'''.<br />
<br />
Click '''Finish'''.<br />
<br />
<br />
Now you will find yourself back at the start of the '''New Project''' Wizard. This is because of the option you chose three paragraphs ago. This time you should select '''PHP -> PHP Project''', then click '''Next >'''.<br />
<br />
Make up a project name. '''moodle''' would be sensible.<br />
<br />
Click '''Finish''', and wait while all the moodle files are checked out of CVS.<br />
<br />
Once it has finished, it will probably ask you if you want to switch to the PHP perspective. Answer '''Yes'''.<br />
<br />
<br />
If you also need another branch (1.6, 1.7, 1.8, ...) repeat all the other steps with a few changes:<br />
* This time you can choose '''Use an existing repository location''' instead of typing all the sourceforge CVS details again.<br />
* Select the appropriate branch. If you don't see the branch you want, see [https://docs.moodle.org/en/Development:Setting_up_Eclipse#Resetting_the_branch_information this Troubleshooting tip].<br />
* Use a different project name (e.g. moodle16, moodle17, etc.).<br />
<br />
==Let your development web server know where your files are==<br />
<br />
Either by editing you web server's config files, or using a symbolic link. Make sure your webserver can see your new working set of files at a sensible URL, so you can test the code you are working on.<br />
<br />
<br />
==Quick tour of some cool features, and remaining configuration changes==<br />
<br />
I find the default workbench setup is pretty good. Here is a quick guide to some of the bits.<br />
<br />
===Navigator===<br />
<br />
To the left is the '''Navigator'''. This is a tree view of all your files. If you double-click on a file, it opens in the editor in the middle. Try opening '''course/lib.php''' now. You will notice that it comes up nicely syntax-highlighted.<br />
<br />
===Error highlighting===<br />
<br />
In the middle of the file, just type any old text, for example "I like Eclipse". Obviously, this is not valid PHP syntax, and Eclipse will notice this, and put a red underline under it. Also, by the scrollbar is a ruler with a red mark in it to show the error.<br />
<br />
You will see some yellow marks lower down the ruler. There are warnings. Click on one, and you will be taken to where that warning is in the file. Hover your mouse over the warning, and you will get a tooltip explaining what the problem might be.<br />
<br />
Save the edited file. (Don't worry that it is broken, we'll clean up the mess later.) Notice that a red error marker is added to the file in the navigator, so you can see that there is a problem. Also, error markers are added to the course folder, and the whole project, so you could see there was an error even if the navigator tree was collapsed.<br />
<br />
You will probably find lots of warnings that the config.php file can't be found. In the navigator, find the file '''config-dist.php'''. Do '''Copy''' then '''Paste''' and choose to call the new file '''config.php'''. Edit this new config.php as normal. You should find that most of the include file warnings have gone now.<br />
<br />
Notice also that there is another marker on each file icon. A little yellow cylinder on most files, but a white-on-brown star on the one you have edited. This is telling you the CVS status of each file. The brown stars are changes you have made but not checked in yet.<br />
<br />
===Outline===<br />
<br />
Over to the right is the Outline view. This shows a list of functions and classes defined in this file. By default, they are listed in the same order as in the file, but if you click on the '''az''' toolbar button, they are sorted into alphabetical order.<br />
<br />
Click on the function name '''add_course_module''' in the Outline. You will see that the editor scrolls to the definition of that function.<br />
<br />
===Code navigation===<br />
<br />
In that function, hover the mouse pointer over the function name '''insert_record'''. After a while, the documentation for that function will appear in a big tooltip.<br />
<br />
Hold down CTRL, move the mouse pointer over the function name '''insert_record''', then click. Eclipse should load '''dmllib.php''', and scroll you to where this function is defined.<br />
<br />
In the main Eclipse toolbar, there are forward and back arrows like in a web browser. Click back now to get back to '''course/lib.php'''.<br />
<br />
===Open resource===<br />
<br />
From the '''Navigate''' menu, choose '''Open Resource...'''. In the dialog that pops up, start typing a filename for instance type '''moodlel'''. In the box in the middle of the dialog, you will see it list all the files in the project whose names start that way. At the bottom is a box which lists the different folders that contain a file with that name. This can be a very quick way of opening files with fairly unique names like moodlelib.php, without having to click through the levels of the navigator tree. Of course, it is not so useful for an index.php file! Click OK now to open moodlelib.php. (It would actually work if you just did CTRL + Shift + R, moodlel, Enter.)<br />
<br />
===Multi-file search===<br />
<br />
Scroll down moodlelib a little bit, and double click on the name of the constant '''MOODLE_INTERNAL''' where it is defined, so that the text is selected. Then, from the '''Search''' menu, choose '''Search...'''. Notice that the '''Containing text''' box has already been filled in for you with the text you just selected. Of course you can just type text into this box without selecting it first. Notice that you can do regular expression searches, but leave that turned off for now. In the '''File name patterns''' box type '''*.css, *.html, *.inc, *.js, *.php, *.xml'''. (This is the most useful general setting for working on moodle. Eclipse will remember this setting, so you only have to enter it once.) Click '''Search'''.<br />
<br />
The search results will appear in a new view underneath the editor. That view has a toolbar with yellow up and down arrows. Click the down arrow a few times and it will take you to the first few matches in the code, opening the relevant files as necessary.<br />
<br />
===Synchronize view===<br />
<br />
I think this is my favorite feature. From the '''Window''' menu, select '''Show View -> Other...'''. In the dialog that pops up, select '''Team -> Synchronize''', then click '''OK'''.<br />
<br />
This opens the Synchronize view below the editor. The view has a toolbar. Click on the first toolbar button, which pops up the Synchronize wizard.<br />
<br />
On the first screen, there will probably only be one option: '''CVS'''. Make sure that is selected, then click '''Next >'''.<br />
<br />
Under '''Scope''', choose '''Workspace''', then click '''Finish'''.<br />
<br />
Wait while it talks to the CVS server. After a while, you will see that the Synchronize view lists course/lib.php, and something called '''.project...''' That is, it is listing just the files you have edited, but not checked in yet.<br />
<br />
'''.project''' is something that belongs to Eclipse that we don't care about. So select it and bring up the context menu, and choose '''Add to .cvsignore...'''. In the dialog that pops up, choose the top option, then click '''OK'''. Then you will find the Synchronize view shows you a '''.cvsignore''' file that you aren't interested in, so add that to .cvsignore too!<br />
<br />
If you double-click on '''course/lib.php''' here, you will see that it opens the compare editor, which is a nice graphical display of the changes in this file.<br />
<br />
If you select a file or files here, then bring up the context menu, you will see the option to '''Commit...''' the changes. (But don't do that now!). This is the easiest way to commit things in Eclipse.<br />
<br />
However, our changes were rubbish, so we want to undo them. So open the context menu again, and choose '''Override and Update'''. This checks a clean copy of the file out of CVS, removing our changes.<br />
<br />
Note that the easiest way to do an ordinary CVS Update is to select the top-level project-folder in the Navigator view on the left, open the context menu, and choose '''Team -> Update'''.<br />
<br />
That's all of the really important features. I'm sure you can learn everything else on your own. And you can always read the built in help!<br />
<br />
===Creating a patch===<br />
<br />
In the synchronise view, right-click an item (file or folder) and choose '''Create Patch...'''. Or in the navigator, right-click an item and choose '''Team -> Create Patch...'''.<br />
<br />
This brings up a two-page wizard. On the first page you can select where you want the patch made. For small patches it can be useful to create them on the clipboard, but normally you will want to save them in a file.<br />
<br />
On the second page, you can set some options, but normally you don't need to change the defaults which are '''Unified''' diff format, and Patch root set to '''Workspace'''. Well, sometimes it is helpful to change the second one to '''Project''' but it is not important.<br />
<br />
There is a corresponding apply patch wizard that you can use to apply a patch to a project.<br />
<br />
===Switching to another branch or version===<br />
<br />
Suppose you have been using a check-out of HEAD from CVS, and then as the 1.9 release approaches, the MOODLE_19_STABLE branch is created, and you want to start following that instead.<br />
# Right click on the moodle project in the navigator view, and select '''Team -> Switch to Another Branch or Version ...'''.<br />
# choose the second radio button: '''Select the tag from the following list'''.<br />
# If the branch you want is not in the '''Matching tags''' box, see [[Development:Setting_up_Eclipse#Resetting the branch information|Resetting the branch information]] below.<br />
# Select the branch you want and click '''Finish'''.<br />
<br />
==Troubleshooting==<br />
<br />
Some tips on how to solve common problems that may crop up.<br />
<br />
===Resetting the branch information===<br />
<br />
Every now and then, Eclipse may lose information on the branch tags it knows about. Hitting refresh tags may fix it, but if not, try the following:<br />
<br />
#Bring up the tag dialogue (example using "Team / Switch to Another Branch or Version").<br />
#Click on Configure tags... (not Refresh tags).<br />
#Select config-dist.php in the top left box (if this is a Moodle checkout).<br />
#Click Add Checked tags.<br />
#Click OK.<br />
#Then you will have all tags.<br />
<br />
(thanks to Tim Hunt)<br />
<br />
This info saved my day to find all branches:<br />
1. Window->Show View->Other. Select CVS->CVS Repositories.<br />
2. Context Menu->New->Repository Location...<br />
3. Fill in the location information identifying your repository and click Finish.<br />
4. Expand the newly-created repository location.<br />
5. Add the branch:<br />
1. Right-click it and expand configure branches and versions.<br />
2. Expand HEAD and select the project moodle.<br />
3. Context Menu->Configure Branches and Versions...<br />
4. In the "Browse files for tags" table, select one or more files <br />
that contain tags you would like to see (for example scroll down <br />
to find config.php).<br />
5. On the right the existing tags will appear.<br />
6. Select the tags: for example MOODLE_15_STABLE<br />
7. Click "Add Selected Tags".<br />
8. Click "OK".<br />
6. Locate branches, MOODLE_19_STABLE, moodle MOODLE_19_STABLE.<br />
7. Context Menu->Check Out As Project.<br />
("stolen" from Joan Codina Filba <br />
General developer forum -> Moodle floating "block"/toolbar released -> Re: Moodle floating "block--PATCH FOR GRADES & ASIGNMENT --PROBLEM)<br />
<br />
===Error loading php files after Ubuntu 7.04 Install===<br />
<br />
A java issue with Ubuntu 7.04 may cause an error when you attempt to load php pages. Refer to:<br />
http://www.plog4u.org/index.php/Using_PHPEclipse_:_Installation_:_Installing_PHPEclipse for details about how to fix this in Ubuntu 7.04.<br />
<br />
After upgrading from Ubuntu 7.04 to 7.10, I had to go in and re-edit the /etc/eclipse/java_home file in order to get the CVS functions to work and be able to open PHP files. When I tried to do a CVS update, I initially received an error about org.eclipse.team.internal.ccvs.ui.wizards.CheckoutWizard). Everything seemed to work again after reapplying the fix for the aforementioned 7.04 java issue.<br />
<br />
==Related Links==<br />
<br />
There is an excellent series of articles published by IBM on using Eclipse for Drupal developement here : [http://www-128.ibm.com/developerworks/ibm/osource/index.html Using open source software to design, develop, and deploy a collaborative Web site Tools and techniques for getting relatively complicated Web sites up and running quickly].<br />
<br />
<br />
[[Category:Developer|Eclipse]]<br />
[[Category:Developer tools|Eclipse]]<br />
<br />
[[fr:Développement:Eclipse]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module_configure&diff=59518Game module configure2009-07-08T15:05:32Z<p>Cabeasley: </p>
<hr />
<div>=All Games=<br />
* To insert a new game use “Add an activity” <br />
<br />
[[Image:Module game configure1.png]]<br />
<br />
* After this the program show the first screen where you can set only the name and the visibility of the new game.<br />
<br />
<br />
[[Image:module game configure2.png]]<br />
<br />
* After the you must use the button “Update the game” to select the kind of game and to set some parameters. <br />
<br />
[[Image:module game configure3.png]]<br />
<br />
* Now you can select the kind of game (e.g. hangman, crossword, cryptex) and the source.<br />
<br />
Depending on the game, you have 3 options for the source:<br />
<br />
a) Use a glossary as the source (all or only one category). Hangman, Crossword and Cryptex all require a glossary as the source.<br />
<br />
b) Use questions as the source. The kind of questions are “simple answer”, multiple choice, and true/false.<br />
<br />
c) Use a quiz as the source.<br />
<br />
Every game needs a different kind of question. For example hangman needs “simple answer” and millionaire needs multiple choice. <br />
<br />
[[Image:module game configure4.png]]<br />
<br />
Notes:<br />
* Input files must be UTF-8 encoded<br />
<br />
==Book With Questions==<br />
The Book With Questions game requires that the Book module be installed.<br />
<br />
==Crossword==<br />
<br />
==Cryptex==<br />
<br />
==Hangman==<br />
<br />
==Hidden Picture==<br />
If using a Glossary as the source of questions for Hidden Picture, the images must be attachments to the glossary entries.<br />
<br />
==Snakes and Ladders==<br />
<br />
==Sudoku==</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module&diff=59479Game module2009-07-07T18:30:18Z<p>Cabeasley: /* Snakes and Ladders */</p>
<hr />
<div>This module contains 8 games and is translated to [https://docs.moodle.org/eu/Jolas_modulua Basque], Dutch, [https://docs.moodle.org/fr/Module_jeux Frence], [https://docs.moodle.org/el/Game_module Greek], Norwegian, Rusian, [https://docs.moodle.org/es/Game_module Spanish]<br />
<br />
==Available games==<br />
<br />
<br />
Glossary Questions<br />
Game True / False<br />
Short answer Multi choice<br />
Hangman X Χ<br />
Crossword X Χ<br />
Cryptex X Χ<br />
Millionaire Χ<br />
Sudoku X Χ Χ Χ<br />
The hidden picture X Χ Χ Χ<br />
Snakes and Ladders Χ Χ<br />
Book with questions X Χ Χ Χ<br />
<br />
=== Hangman===<br />
This game takes words from either a Glossary or quiz short answer questions and generates a hangman puzzle. Teacher can set the number of words that each game contains, if shows the first or last letter, or if show the question or the answer at the end.<br />
<br />
[[Image:Hangman.jpg]]<br />
<br />
===Crossword=== <br />
This game takes words from either a Glossary or quiz short answer questions and generates a random crossword puzzle. Teacher can set the maximum number of columns/rows or words that contains. Student can press the button “Check crossword” to check if the answers are correct. Every crossword is dynamic so it is different to every student.<br />
<br />
[[Image:Crossword.jpg]]<br />
<br />
=== Cryptex=== <br />
This game is like a crossword but the answers are hidden inside a random cryptex.<br />
<br />
[[Image:Cryptex.jpg]]<br />
<br />
===Millionaire=== <br />
This game takes words from multiple choice quiz questions and creates a “Who wants to be a Millionaire” style game complete with the three lifelines. <br />
<br />
[[Image:Millionaire.jpg]]<br />
<br />
====How to Play Millionaire====<br />
The rules of the Millionaire game are simple: you must answer each question correctly to proceed - if you answer one question wrong, the game is over. Look in the bottom-right corner of your screen to see if you answered the question correctly or not.<br />
<br />
To end or start a new game, click on the 'X' next to the lifelines (top of screen). You will be presented with a new page where you have two options: you can end the game and return to the course, or you can start a new game.<br />
<br />
=== Sudoku=== <br />
This game shows a sudoku puzzle to the students with not enough numbers to allow it to be solved. For each question the student correctly answers an additional number is slotted into the puzzle to make it easier to solve.<br />
<br />
[[Image:Sudoku.jpg]]<br />
<br />
=== The hidden picture=== <br />
This game randomly grabs an image from a glossary and hides it behind panels. As each question is answered correctly a portion of the image is revealed. How fast can they guess the image?<br />
<br />
[[Image:Hidden picture.jpg]]<br />
<br />
=== Snakes and Ladders=== <br />
The students have to traverse a traditional “Snakes and Ladders” board by answering questions taken from either a Glossary or quiz short answer questions. As they get an answer right, the dice is rolled and a random number displayed. The game piece is moved ahead that many squares. If the game piece is in the bottom of a ladder and the answer is correct, it goes to the top. If the game piece is in head of snake and the answer is wrong, it goes to the tail.<br />
<br />
[[Image:snakes_and_ladders.jpg]]<br />
<br />
=== Book with questions=== <br />
When the student answers correct can go to the next chapter.<br />
Source for each game<br />
<br />
<br />
<br />
==Other page links==<br />
=== How to install === <br />
[[Game_module_install|How to install]]<br />
=== How to configure === <br />
[[Game_module_configure|How to configure]]<br />
===Demo video and References===<br />
[[Game_module_demo|References & Demo video]] <br />
=== Info for developers === <br />
[[Game_module_developers|Info for developers]]<br />
=== How I can help? === <br />
[[Game_module_howtohelp|How I can help?]]<br />
=== Publishes === <br />
[[Game_module_public|Publishes]]<br />
=== Sites that uses it === <br />
[[Game_module_sites|Sites that uses it]]<br />
<br />
<br />
==See also==<br />
*[http://moodle.org/mod/data/view.php?d=13&rid=1196 Game]'s Module and Plugin database page<br />
*[http://download.moodle.org/plugins/mod/game.zip Download latest version]<br />
*[http://cvs.moodle.org/contrib/plugins/mod/game/ Browse CVS]<br />
*[http://tracker.moodle.org/browse/CONTRIB/component/10295 Bugs and Issues] at Tracker<br />
*[http://moodle.org/mod/forum/view.php?id=7220 Discussion in English] at Game Module Forum<br />
*[http://moodle.org/mod/forum/discuss.php?d=92033 Success stories of Module Game] at Game Module Forum<br />
*[http://moodle.org/mod/forum/discuss.php?d=92581 Suggest modes of educational exploitation] at Game Module Forum<br />
*[http://bdaloukas.gr/moodle Demo site] *[http://bdaloukas.gr/moodle/download/game/doc/game.swf Demo flash video]<br />
<br />
[[Category:Contributed code]]<br />
<br />
[[fr:Module jeux]]<br />
[[es:Game module]]<br />
[[el:Game module]]<br />
[[eu:Jolas modulua]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module_configure&diff=59478Game module configure2009-07-07T18:19:05Z<p>Cabeasley: </p>
<hr />
<div>=All Games=<br />
* To insert a new game use “Add an activity” <br />
<br />
[[Image:Module game configure1.png]]<br />
<br />
* After this the program show the first screen where you can set only the name and the visibility of the new game.<br />
<br />
<br />
[[Image:module game configure2.png]]<br />
<br />
* After the you must use the button “Update the game” to select the kind of game and to set some parameters. <br />
<br />
[[Image:module game configure3.png]]<br />
<br />
* Now you can select the kind of game (e.g. hangman, crossword, cryptex) and the source.<br />
<br />
Depending on the game, you have 3 options for the source:<br />
<br />
a) Use a glossary as the source (all or only one category). Hangman, Crossword and Cryptex all require a glossary as the source.<br />
<br />
b) Use questions as the source. The kind of questions are “simple answer”, multiple choice, and true/false.<br />
<br />
c) Use a quiz as the source.<br />
<br />
Every game needs a different kind of question. For example hangman needs “simple answer” and millionaire needs multiple choice. <br />
<br />
[[Image:module game configure4.png]]<br />
<br />
Notes:<br />
* Input files must be UTF-8 encoded<br />
<br />
==Crossword==<br />
<br />
==Cryptex==<br />
<br />
==Hangman==<br />
<br />
==Hidden Picture==<br />
If using a Glossary as the source of questions for Hidden Picture, the images must be attachments to the glossary entries.<br />
<br />
==Snakes and Ladders==<br />
<br />
==Sudoku==</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module_configure&diff=59476Game module configure2009-07-07T18:02:15Z<p>Cabeasley: </p>
<hr />
<div>=All Games=<br />
* To insert a new game use “Add an activity” <br />
<br />
[[Image:Module game configure1.png]]<br />
<br />
* After this the program show the first screen where you can set only the name and the visibility of the new game.<br />
<br />
<br />
[[Image:module game configure2.png]]<br />
<br />
* After the you must use the button “Update the game” to select the kind of game and to set some parameters. <br />
<br />
[[Image:module game configure3.png]]<br />
<br />
* Now you can select the kind of game (e.g. hangman, crossword, cryptex) and the source.<br />
<br />
Depending on the game, you have 3 options for the source:<br />
<br />
a) Use a glossary as the source (all or only one category). Hangman, Crossword and Cryptex all require a glossary as the source.<br />
<br />
b) Use questions as the source. The kind of questions are “simple answer”, multiple choice, and true/false.<br />
<br />
c) Use a quiz as the source.<br />
<br />
Every game needs a different kind of question. For example hangman needs “simple answer” and millionaire needs multiple choice. <br />
<br />
[[Image:module game configure4.png]]<br />
<br />
Notes:<br />
* Input files must be UTF-8 encoded<br />
<br />
==Hidden Picture==<br />
If using a Glossary as the source of questions for Hidden Picture, the images must be attachments to the glossary entries.</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module_configure&diff=59475Game module configure2009-07-07T17:59:17Z<p>Cabeasley: </p>
<hr />
<div>* To insert a new game use “Add an activity” <br />
<br />
[[Image:Module game configure1.png]]<br />
<br />
* After this the program show the first screen where you can set only the name and the visibility of the new game.<br />
<br />
<br />
[[Image:module game configure2.png]]<br />
<br />
* After the you must use the button “Update the game” to select the kind of game and to set some parameters. <br />
<br />
[[Image:module game configure3.png]]<br />
<br />
* Now you can select the kind of game (e.g. hangman, crossword, cryptex) and the source.<br />
<br />
Depending on the game, you have 3 options for the source:<br />
<br />
a) Use a glossary as the source (all or only one category). Hangman, Crossword and Cryptex all require a glossary as the source.<br />
<br />
b) Use questions as the source. The kind of questions are “simple answer”, multiple choice, and true/false.<br />
<br />
c) Use a quiz as the source.<br />
<br />
Every game needs a different kind of question. For example hangman needs “simple answer” and millionaire needs multiple choice. <br />
<br />
[[Image:module game configure4.png]]<br />
<br />
Notes:<br />
* Input files must be UTF-8 encoded<br />
<br />
=Hidden Picture=<br />
If using a Glossary as the source of questions for Hidden Picture, the images must be attachments to the glossary entries.</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module_configure&diff=59474Game module configure2009-07-07T17:50:00Z<p>Cabeasley: </p>
<hr />
<div>* To insert a new game use “Add an activity” <br />
<br />
[[Image:Module game configure1.png]]<br />
<br />
* After this the program show the first screen where you can set only the name and the visibility of the new game.<br />
<br />
<br />
[[Image:module game configure2.png]]<br />
<br />
* After the you must use the button “Update the game” to select the kind of game and to set some parameters. <br />
<br />
[[Image:module game configure3.png]]<br />
<br />
* Now you can select the kind of game (e.g. hangman, crossword, cryptex) and the source.<br />
<br />
Depending on the game, you have 3 options for the source:<br />
<br />
a) Use a glossary as the source (all or only one category). Hangman, Crossword and Cryptex all require a glossary as the source.<br />
<br />
b) Use questions as the source. The kind of questions are “simple answer”, multiple choice, and true/false.<br />
<br />
c) Use a quiz as the source.<br />
<br />
Every game needs a different kind of question. For example hangman needs “simple answer” and millionaire needs multiple choice. <br />
<br />
[[Image:module game configure4.png]]<br />
<br />
Notes:<br />
* Input files must be UTF-8 encoded<br />
<br />
=Games=<br />
==Hidden Picture==</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module&diff=59470Game module2009-07-07T17:04:24Z<p>Cabeasley: /* Millionaire */</p>
<hr />
<div>This module contains 8 games and is translated to [https://docs.moodle.org/eu/Jolas_modulua Basque], Dutch, [https://docs.moodle.org/fr/Module_jeux Frence], [https://docs.moodle.org/el/Game_module Greek], Norwegian, Rusian, [https://docs.moodle.org/es/Game_module Spanish]<br />
<br />
==Available games==<br />
<br />
<br />
Glossary Questions<br />
Game True / False<br />
Short answer Multi choice<br />
Hangman X Χ<br />
Crossword X Χ<br />
Cryptex X Χ<br />
Millionaire Χ<br />
Sudoku X Χ Χ Χ<br />
The hidden picture X Χ Χ Χ<br />
Snakes and Ladders Χ Χ<br />
Book with questions X Χ Χ Χ<br />
<br />
=== Hangman===<br />
This game takes words from either a Glossary or quiz short answer questions and generates a hangman puzzle. Teacher can set the number of words that each game contains, if shows the first or last letter, or if show the question or the answer at the end.<br />
<br />
[[Image:Hangman.jpg]]<br />
<br />
===Crossword=== <br />
This game takes words from either a Glossary or quiz short answer questions and generates a random crossword puzzle. Teacher can set the maximum number of columns/rows or words that contains. Student can press the button “Check crossword” to check if the answers are correct. Every crossword is dynamic so it is different to every student.<br />
<br />
[[Image:Crossword.jpg]]<br />
<br />
=== Cryptex=== <br />
This game is like a crossword but the answers are hidden inside a random cryptex.<br />
<br />
[[Image:Cryptex.jpg]]<br />
<br />
===Millionaire=== <br />
This game takes words from multiple choice quiz questions and creates a “Who wants to be a Millionaire” style game complete with the three lifelines. <br />
<br />
[[Image:Millionaire.jpg]]<br />
<br />
====How to Play Millionaire====<br />
The rules of the Millionaire game are simple: you must answer each question correctly to proceed - if you answer one question wrong, the game is over. Look in the bottom-right corner of your screen to see if you answered the question correctly or not.<br />
<br />
To end or start a new game, click on the 'X' next to the lifelines (top of screen). You will be presented with a new page where you have two options: you can end the game and return to the course, or you can start a new game.<br />
<br />
=== Sudoku=== <br />
This game shows a sudoku puzzle to the students with not enough numbers to allow it to be solved. For each question the student correctly answers an additional number is slotted into the puzzle to make it easier to solve.<br />
<br />
[[Image:Sudoku.jpg]]<br />
<br />
=== The hidden picture=== <br />
This game randomly grabs an image from a glossary and hides it behind panels. As each question is answered correctly a portion of the image is revealed. How fast can they guess the image?<br />
<br />
[[Image:Hidden picture.jpg]]<br />
<br />
=== Snakes and Ladders=== <br />
The students have to traverse a traditional “Snakes and Ladders” board by answering questions taken from either a Glossary or quiz short answer questions. As they get n answer right the dice is rolled and a random number displayed. If the student is in the bottom of the ladders and answers correct goes to the top. If he is in head of snake and answers wrong goes to tail.<br />
<br />
[[Image:snakes_and_ladders.jpg]]<br />
<br />
<br />
=== Book with questions=== <br />
When the student answers correct can go to the next chapter.<br />
Source for each game<br />
<br />
<br />
<br />
==Other page links==<br />
=== How to install === <br />
[[Game_module_install|How to install]]<br />
=== How to configure === <br />
[[Game_module_configure|How to configure]]<br />
===Demo video and References===<br />
[[Game_module_demo|References & Demo video]] <br />
=== Info for developers === <br />
[[Game_module_developers|Info for developers]]<br />
=== How I can help? === <br />
[[Game_module_howtohelp|How I can help?]]<br />
=== Publishes === <br />
[[Game_module_public|Publishes]]<br />
=== Sites that uses it === <br />
[[Game_module_sites|Sites that uses it]]<br />
<br />
<br />
==See also==<br />
*[http://moodle.org/mod/data/view.php?d=13&rid=1196 Game]'s Module and Plugin database page<br />
*[http://download.moodle.org/plugins/mod/game.zip Download latest version]<br />
*[http://cvs.moodle.org/contrib/plugins/mod/game/ Browse CVS]<br />
*[http://tracker.moodle.org/browse/CONTRIB/component/10295 Bugs and Issues] at Tracker<br />
*[http://moodle.org/mod/forum/view.php?id=7220 Discussion in English] at Game Module Forum<br />
*[http://moodle.org/mod/forum/discuss.php?d=92033 Success stories of Module Game] at Game Module Forum<br />
*[http://moodle.org/mod/forum/discuss.php?d=92581 Suggest modes of educational exploitation] at Game Module Forum<br />
*[http://bdaloukas.gr/moodle Demo site] *[http://bdaloukas.gr/moodle/download/game/doc/game.swf Demo flash video]<br />
<br />
[[Category:Contributed code]]<br />
<br />
[[fr:Module jeux]]<br />
[[es:Game module]]<br />
[[el:Game module]]<br />
[[eu:Jolas modulua]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module&diff=59467Game module2009-07-07T16:36:20Z<p>Cabeasley: /* Millionaire */</p>
<hr />
<div>This module contains 8 games and is translated to [https://docs.moodle.org/eu/Jolas_modulua Basque], Dutch, [https://docs.moodle.org/fr/Module_jeux Frence], [https://docs.moodle.org/el/Game_module Greek], Norwegian, Rusian, [https://docs.moodle.org/es/Game_module Spanish]<br />
<br />
==Available games==<br />
<br />
<br />
Glossary Questions<br />
Game True / False<br />
Short answer Multi choice<br />
Hangman X Χ<br />
Crossword X Χ<br />
Cryptex X Χ<br />
Millionaire Χ<br />
Sudoku X Χ Χ Χ<br />
The hidden picture X Χ Χ Χ<br />
Snakes and Ladders Χ Χ<br />
Book with questions X Χ Χ Χ<br />
<br />
=== Hangman===<br />
This game takes words from either a Glossary or quiz short answer questions and generates a hangman puzzle. Teacher can set the number of words that each game contains, if shows the first or last letter, or if show the question or the answer at the end.<br />
<br />
[[Image:Hangman.jpg]]<br />
<br />
===Crossword=== <br />
This game takes words from either a Glossary or quiz short answer questions and generates a random crossword puzzle. Teacher can set the maximum number of columns/rows or words that contains. Student can press the button “Check crossword” to check if the answers are correct. Every crossword is dynamic so it is different to every student.<br />
<br />
[[Image:Crossword.jpg]]<br />
<br />
=== Cryptex=== <br />
This game is like a crossword but the answers are hidden inside a random cryptex.<br />
<br />
[[Image:Cryptex.jpg]]<br />
<br />
===[[Millionaire]]=== <br />
This game takes words from multiple choice quiz questions and creates a “Who wants to be a Millionaire” style game complete with the three lifelines. <br />
<br />
[[Image:Millionaire.jpg]]<br />
<br />
=== Sudoku=== <br />
This game shows a sudoku puzzle to the students with not enough numbers to allow it to be solved. For each question the student correctly answers an additional number is slotted into the puzzle to make it easier to solve.<br />
<br />
[[Image:Sudoku.jpg]]<br />
<br />
=== The hidden picture=== <br />
This game randomly grabs an image from a glossary and hides it behind panels. As each question is answered correctly a portion of the image is revealed. How fast can they guess the image?<br />
<br />
[[Image:Hidden picture.jpg]]<br />
<br />
=== Snakes and Ladders=== <br />
The students have to traverse a traditional “Snakes and Ladders” board by answering questions taken from either a Glossary or quiz short answer questions. As they get n answer right the dice is rolled and a random number displayed. If the student is in the bottom of the ladders and answers correct goes to the top. If he is in head of snake and answers wrong goes to tail.<br />
<br />
[[Image:snakes_and_ladders.jpg]]<br />
<br />
<br />
=== Book with questions=== <br />
When the student answers correct can go to the next chapter.<br />
Source for each game<br />
<br />
<br />
<br />
==Other page links==<br />
=== How to install === <br />
[[Game_module_install|How to install]]<br />
=== How to configure === <br />
[[Game_module_configure|How to configure]]<br />
===Demo video and References===<br />
[[Game_module_demo|References & Demo video]] <br />
=== Info for developers === <br />
[[Game_module_developers|Info for developers]]<br />
=== How I can help? === <br />
[[Game_module_howtohelp|How I can help?]]<br />
=== Publishes === <br />
[[Game_module_public|Publishes]]<br />
=== Sites that uses it === <br />
[[Game_module_sites|Sites that uses it]]<br />
<br />
<br />
==See also==<br />
*[http://moodle.org/mod/data/view.php?d=13&rid=1196 Game]'s Module and Plugin database page<br />
*[http://download.moodle.org/plugins/mod/game.zip Download latest version]<br />
*[http://cvs.moodle.org/contrib/plugins/mod/game/ Browse CVS]<br />
*[http://tracker.moodle.org/browse/CONTRIB/component/10295 Bugs and Issues] at Tracker<br />
*[http://moodle.org/mod/forum/view.php?id=7220 Discussion in English] at Game Module Forum<br />
*[http://moodle.org/mod/forum/discuss.php?d=92033 Success stories of Module Game] at Game Module Forum<br />
*[http://moodle.org/mod/forum/discuss.php?d=92581 Suggest modes of educational exploitation] at Game Module Forum<br />
*[http://bdaloukas.gr/moodle Demo site] *[http://bdaloukas.gr/moodle/download/game/doc/game.swf Demo flash video]<br />
<br />
[[Category:Contributed code]]<br />
<br />
[[fr:Module jeux]]<br />
[[es:Game module]]<br />
[[el:Game module]]<br />
[[eu:Jolas modulua]]</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module_configure&diff=58863Game module configure2009-06-25T14:59:43Z<p>Cabeasley: </p>
<hr />
<div>* To insert a new game use “Add an activity” <br />
<br />
[[Image:Module game configure1.png]]<br />
<br />
* After this the program show the first screen where you can set only the name and the visibility of the new game.<br />
<br />
<br />
[[Image:module game configure2.png]]<br />
<br />
* After the you must use the button “Update the game” to select the kind of game and to set some parameters. <br />
<br />
[[Image:module game configure3.png]]<br />
<br />
* Now you can select the kind of game (e.g. hangman, crossword, cryptex) and the source.<br />
<br />
Depending on the game, you have 3 options for the source:<br />
<br />
a) Use a glossary as the source (all or only one category). Hangman, Crossword and Cryptex all require a glossary as the source.<br />
<br />
b) Use questions as the source. The kind of questions are “simple answer”, multiple choice, and true/false.<br />
<br />
c) Use a quiz as the source.<br />
<br />
Every game needs a different kind of question. For example hangman needs “simple answer” and millionaire needs multiple choice. <br />
<br />
[[Image:module game configure4.png]]<br />
<br />
<br />
Notes:<br />
<br />
* Input files must be UTF-8 encoded</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module_configure&diff=58858Game module configure2009-06-25T14:52:24Z<p>Cabeasley: </p>
<hr />
<div>* To insert a new game use “Add an activity” <br />
<br />
[[Image:Module game configure1.png]]<br />
<br />
* After this the program show the first screen where you can set only the name and the visibility of the new game.<br />
<br />
<br />
[[Image:module game configure2.png]]<br />
<br />
* After the you must use the button “Update the game” to select the kind of game and to set some parameters. <br />
<br />
[[Image:module game configure3.png]]<br />
<br />
* Now you can select the kind of game (e.g. hangman, crossword, cryptex) and the source.<br />
<br />
You have 3 options for the source:<br />
<br />
a) Use a glossary as the source (all or only one category).<br />
<br />
b) Use questions as the source. The kind of questions are “simple answer”, multiple choice, and true/false.<br />
<br />
c) Use a quiz as the source.<br />
<br />
Every game needs a different kind of question. For example hangman needs “simple answer” and millionaire needs multiple choice. <br />
<br />
[[Image:module game configure4.png]]<br />
<br />
<br />
Notes:<br />
<br />
* Input files must be UTF-8 encoded</div>Cabeasleyhttps://docs.moodle.org/310/en/index.php?title=Game_module_configure&diff=58774Game module configure2009-06-24T21:08:53Z<p>Cabeasley: </p>
<hr />
<div>* To insert a new game use “Add an activity” <br />
<br />
[[Image:Module game configure1.png]]<br />
<br />
* After this the program show the first screen where you can set only the name and the visibility of the new game.<br />
<br />
<br />
[[Image:module game configure2.png]]<br />
<br />
* After the you must use the button “Update the game” to select the kind of game and to set some parameters. <br />
<br />
[[Image:module game configure3.png]]<br />
<br />
* Now you can select the kind of game (e.g. hangman, crossword, cryptex) and the source.<br />
You have 3 options:<br />
a) Use a glossary as the source (all or only one category).<br />
b) Use questions as the source. The kind of questions are “simple answer”, multiple choice, and true/false.<br />
Every game needs a different kind of question. For example hangman needs “simple answer” and millionaire needs multi choice. <br />
<br />
[[Image:module game configure4.png]]<br />
<br />
* This is all. Now you can enjoy the game.</div>Cabeasley