Changeset View
Changeset View
Standalone View
Standalone View
plugins/python/scripter/Manual.html
| 1 | <?xml version="1.0" encoding="utf-8"?> | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" | ||
|---|---|---|---|---|---|
| 2 | <!DOCTYPE html> | 2 | "http://www.w3.org/TR/html4/strict.dtd"> | ||
| 3 | 3 | <html> | |||
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> | 4 | <head> | ||
| 5 | <head><title>Scripter Plugin Manual</title> | 5 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | ||
| 6 | <title>Scripter Plugin Manual</title> | ||||
| 6 | </head> | 7 | </head> | ||
| 7 | <body> | 8 | <body> | ||
| 8 | <h1 id="scripter">Scripter</h1> | 9 | <h1 id="scripter">Scripter</h1> | ||
| Context not available. | |||||
| 11 | <p>Write python code in the topmost code editor and press the play button on the top left to run it.</p> | 12 | <p>Write python code in the topmost code editor and press the play button on the top left to run it.</p> | ||
| 12 | <p>The box at the bottom represents the output, with error messages when it goes wrong.</p> | 13 | <p>The box at the bottom represents the output, with error messages when it goes wrong.</p> | ||
| 13 | <p>Press <strong>Clear</strong> if you want to clear the bottom output.</p> | 14 | <p>Press <strong>Clear</strong> if you want to clear the bottom output.</p> | ||
| 14 | <h2 id="using-the-debugger.">Using the debugger.</h2> | 15 | <h2 id="using-the-debugger.">Using the debugger</h2> | ||
| 15 | <p>Using the Debugger tab, you can go over each line separately to check what is going on in your program at that time. This is very useful to check which variables you’re using.</p> | 16 | <p>Using the Debugger tab, you can go over each line separately to check what is going on in your program at that time. This is very useful to check which variables you are using.</p> | ||
| 16 | <p>To start using it, press the <strong>Debug</strong> button above, next to the play button.</p> | 17 | <p>To start using it, press the <strong>Debug</strong> button above, next to the play button.</p> | ||
| 17 | <p>Then, switch to the <strong>Debugger</strong> tab. Both buttons are enabled now.</p> | 18 | <p>Then, switch to the <strong>Debugger</strong> tab below. Both buttons are enabled now.</p> | ||
| 18 | <p>The red button is the <strong>Stop</strong> button, to stop debugging.</p> | 19 | <p>The red button is the <strong>Stop</strong> button, to stop debugging.</p> | ||
| 19 | <p>The second button is the <strong>Step</strong> button. Use this button to go to the next line. As you press this, the program gets further in its debugging.</p> | 20 | <p>The second button is the <strong>Step</strong> button. Use this button to go to the next line. As you press this, the program gets further in its debugging.</p> | ||
| 20 | <p>Once you get near variables, the table at the bottom will show the interesting information, because for each variable it’ll show the following:</p> | 21 | <p>Once you get near variables, the table at the bottom will show the interesting information. For each variable it will show the following:</p> | ||
| 21 | <dl> | 22 | <dl> | ||
| 22 | <dt>Scope</dt> | 23 | <dt>Scope</dt> | ||
| 23 | <dd>The Scope can be either local or global. What this means is whether the variable | 24 | <dd>The Scope of the variable can be either local or global. A global python variable is accesible to all scopes within a script. A local variable is available only in the scope it is defined. The debugger distinguishes between these two. | ||
| 24 | </dd> | 25 | </dd> | ||
| 25 | <dt>Name</dt> | 26 | <dt>Name</dt> | ||
| 26 | <dd>The name of the variable. | 27 | <dd>The name of the variable. | ||
| Context not available. | |||||
| 29 | <dd>The value of the variable, gotten via print(str(variable)). | 30 | <dd>The value of the variable, gotten via print(str(variable)). | ||
| 30 | </dd> | 31 | </dd> | ||
| 31 | <dt>Type</dt> | 32 | <dt>Type</dt> | ||
| 32 | <dd>The type of variable it is. Maybe it’s a string, or a integer, or maybe it is a python object. | 33 | <dd>The type of variable it is. E.g. tuple, list, dictionary, string etc. | ||
| 33 | </dd> | 34 | </dd> | ||
| 34 | </dl> | 35 | </dl> | ||
| 35 | <h1 id="file-menu">File Menu</h1> | 36 | <h1 id="file-menu">File Menu</h1> | ||
| Context not available. | |||||
| 40 | <dt>Open</dt> | 41 | <dt>Open</dt> | ||
| 41 | <dd>Open a python script | 42 | <dd>Open a python script | ||
| 42 | </dd> | 43 | </dd> | ||
| 44 | <dt>Reload File</dt> | ||||
| 45 | <dd>Reload the currently open file. | ||||
| 43 | <dt>Save</dt> | 46 | <dt>Save</dt> | ||
| 44 | <dd>save the script to file. | 47 | <dd>Save the script to file. | ||
| 45 | </dd> | 48 | </dd> | ||
| 46 | <dt>Save As</dt> | 49 | <dt>Save As</dt> | ||
| 47 | <dd>save the current script as a new file. | 50 | <dd>Save the current script as a new file. | ||
| 48 | </dd> | 51 | </dd> | ||
| 49 | <dt>Close</dt> | 52 | <dt>Close</dt> | ||
| 50 | <dd>Close the scripter | 53 | <dd>Close the scripter | ||
| Context not available. | |||||
| 53 | <h2 id="settings">Settings</h2> | 56 | <h2 id="settings">Settings</h2> | ||
| 54 | <dl> | 57 | <dl> | ||
| 55 | <dt>Syntax Highlighter</dt> | 58 | <dt>Syntax Highlighter</dt> | ||
| 56 | <dd>The Theme for Syntax Highlighting. Also includes background and foreground. | 59 | <dd>The theme used for syntax highlighting. Also includes background and foreground. | ||
| 57 | </dd> | 60 | </dd> | ||
| 58 | <dt>Fonts</dt> | 61 | <dt>Fonts</dt> | ||
| 59 | <dd>The font used in the code editor. | 62 | <dd>The font used in the code editor. | ||
| Context not available. | |||||