Skip to content

Commit 637b243

Browse files
authored
Merge pull request #173 from easycoder/dev
Refactor help
2 parents 75052ba + 6dc0a1e commit 637b243

22 files changed

+69
-69
lines changed

iwsy/resources/help/action-crossfade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This action crossfades the text of a block, replacing it with new content.
66

7-
~img:resources/users/2020/160/1/images/quickstart/action-crossfade.png:100%~
7+
~img:https://easycoder.github.io/iwsy/resources/help/img/action-crossfade.png|100%~
88

99
The **Action**, **Name** and **Label** properties are present for all actions.
1010

iwsy/resources/help/action-fade.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
This action fades one or more blocks up or down by varying their opacity.
66

7-
~img:resources/users/2020/160/1/images/quickstart/action-fade.png:100%~
7+
~img:https://easycoder.github.io/iwsy/resources/help/img/action-fade.png|100%~
88

99
The **Action**, **Name** and **Label** properties are present for all actions.
1010

11-
The **Blocks** property is a list of blocks that will be handled by this step. Add another block to the list by clicking the ~img:resources/icon/plus.png:icon~ button.
11+
The **Blocks** property is a list of blocks that will be handled by this step. Add another block to the list by clicking the ~img:https://easycoder.github.io/iwsy/resources/icon/plus.png|icon~ button.
1212

1313
The **Duration** property is the time in seconds the fade should take.
1414

1515
The **Continue** is **true** or **false**. It governs whether the next step should run at the same time as this one (**true**) or if it should wait until the fade has completed (**false**). A common use for this is to implement a crossfade, where one scene dissoves into another. The **fade down** and **fade up** steps both have the same **Duration** and the first one has **Continue** set **true**. There's also a separate **Crossfade** action; see the documentation ~page:action-crossfade:here~.
1616

17-
When this action runs the blocks referenced are all faded at the same time. You can change the order of display by moving blocks up the list using the ~img:resources/icon/up.png:icon~ buttons. (This has no effect on the show; it's just a convenience for the programmer.) You can delete any block using the ~img:resources/icon/stop.png:icon~ buttons.
17+
When this action runs the blocks referenced are all faded at the same time. You can change the order of display by moving blocks up the list using the ~img:https://easycoder.github.io/iwsy/resources/icon/up.png|icon~ buttons. (This has no effect on the show; it's just a convenience for the programmer.) You can delete any block using the ~img:https://easycoder.github.io/iwsy/resources/icon/stop.png|icon~ buttons.
1818

1919
Fades and other animated effects run at 25 frames/sec, as a compromise between visual smoothness and processing requirements.
2020

iwsy/resources/help/action-init.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Every ~iwsy~ presentation starts with an `init` action, which defines the environment in which the presentation will run. The editor looks like this:
66

7-
~img:resources/users/2020/160/1/images/help/editor-init.png:100%~
7+
~img:https://easycoder.github.io/iwsy/resources/help/img/editor-init.png|100%~
88

99
Here there are a set of _properties_ relating to the `init` action. All these are editable. The Title is there for your convenience; it has no affect on the presentation. The properties are as follows:
1010

iwsy/resources/help/action-pause.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This action pauses the presentation for a given nmber of seconds.
66

7-
~img:resources/users/2020/160/1/images/quickstart/pause.png:100%~
7+
~img:https://easycoder.github.io/iwsy/resources/help/img/pause.png|100%~
88

99
The **Action**, **Name** and **Label** properties are present for all actions.
1010

iwsy/resources/help/action-set-content.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
This action calls blocks into existence and assigns content to them. Here's a typical example:
66

7-
~img:resources/users/2020/160/1/images/quickstart/setup-all-blocks.png:100%~
7+
~img:https://easycoder.github.io/iwsy/resources/help/img/setup-all-blocks.png|100%~
88

9-
The **Action**, **Name** and **Label** properties are present for all actions, so that just leaves **Blocks**. This is a list of blocks that will be handled by this step. For each one a **content** items is defined; blocks that are just used to hold a background image or color will leave this empty. Add another block to the list by clicking the ~img:resources/icon/plus.png:icon~ button.
9+
The **Action**, **Name** and **Label** properties are present for all actions, so that just leaves **Blocks**. This is a list of blocks that will be handled by this step. For each one a **content** items is defined; blocks that are just used to hold a background image or color will leave this empty. Add another block to the list by clicking the ~img:https://easycoder.github.io/iwsy/resources/icon/plus.png|icon~ button.
1010

11-
When this action runs the blocks are created in the order they are listed, so a block lower down the list will mask one that's higher up if they overlap. You can change the order of display by moving blocks up using the ~img:resources/icon/up.png:icon~ buttons. You can delete any block using the ~img:resources/icon/stop.png:icon~ buttons.
11+
When this action runs the blocks are created in the order they are listed, so a block lower down the list will mask one that's higher up if they overlap. You can change the order of display by moving blocks up using the ~img:https://easycoder.github.io/iwsy/resources/icon/up.png|icon~ buttons. You can delete any block using the ~img:https://easycoder.github.io/iwsy/resources/icon/stop.png|icon~ buttons.
1212

1313
Setting content does not make a block visible. To do that you need either ~page:action-show-hide:show~ or ~page:action-fade:fade up~.
1414

iwsy/resources/help/action-show-hide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
This action shows or hides one or more blocks.
66

7-
~img:resources/users/2020/160/1/images/quickstart/action-show.png:100%~
7+
~img:https://easycoder.github.io/iwsy/resources/help/img/action-show.png|100%~
88

9-
The **Action**, **Name** and **Label** properties are present for all actions, so that just leaves **Blocks**. This is a list of blocks that will be handled by this step. Add another block to the list by clicking the ~img:resources/icon/plus.png:icon~ button.
9+
The **Action**, **Name** and **Label** properties are present for all actions, so that just leaves **Blocks**. This is a list of blocks that will be handled by this step. Add another block to the list by clicking the ~img:https://easycoder.github.io/iwsy/resources/icon/plus.png|icon~ button.
1010

11-
When this action runs the blocks referenced are all made visible or invisible. You can change the order of display by moving blocks up the list using the ~img:resources/icon/up.png:icon~ buttons. (This has no effect on the show; it's just a convenience for the programmer.) You can delete any block using the ~img:resources/icon/stop.png:icon~ buttons.
11+
When this action runs the blocks referenced are all made visible or invisible. You can change the order of display by moving blocks up the list using the ~img:https://easycoder.github.io/iwsy/resources/icon/up.png|icon~ buttons. (This has no effect on the show; it's just a convenience for the programmer.) You can delete any block using the ~img:https://easycoder.github.io/iwsy/resources/icon/stop.png|icon~ buttons.
1212

1313
Next: ~page:action-fade:Fade up and down~

iwsy/resources/help/action-transition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This action performs any combination of zoom, move and changing text size and/or color.
66

7-
~img:resources/users/2020/160/1/images/quickstart/zoom-title.png:100%~
7+
~img:https://easycoder.github.io/iwsy/resources/help/img/zoom-title.png|100%~
88

99
The **Action**, **Name** and **Label** properties are present for all actions.
1010

iwsy/resources/help/buttons.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@
44

55
Above this Help page, under the banner, is a panel of buttons. The job of each button is as follows:
66

7-
~img:resources/icon/new.png:{float:left;height:2em;margin-right:1em}~ Start a new presentation. This clears the workspace. If you have unsaved work it will prompt you to save it.
7+
~img:https://easycoder.github.io/iwsy/resources/icon/new|png:{float:left;height:2em;margin-right:1em}~ Start a new presentation. This clears the workspace. If you have unsaved work it will prompt you to save it.
88

9-
~img:resources/icon/open.png:{float:left;height:2em;margin-right:1em}~ Open a saved presentation. This displays a list of all presentations and lets you select one. Note that if you are not a registered user, presentations will be saved into your browser's private space. For registered users they are saved to the ~iwsy~ website, into a space allocated to that user.
9+
~img:https://easycoder.github.io/iwsy/resources/icon/open.png|{float:left;height:2em;margin-right:1em}~ Open a saved presentation. This displays a list of all presentations and lets you select one. Note that if you are not a registered user, presentations will be saved into your browser's private space. For registered users they are saved to the ~iwsy~ website, into a space allocated to that user.
1010

1111
If you have unsaved work you will be prompted to save it before opening the list.
1212

13-
~img:resources/icon/save.png:{float:left;height:2em;margin-right:1em}~ Save your current work. It will be saved using whatever name is shown in the **Script name** box below the buttons. If this box is empty you will be prompted for a name. Files all have ~m:.json~ extensions; if this is omitted it will be added.
13+
~img:https://easycoder.github.io/iwsy/resources/icon/save.png|{float:left;height:2em;margin-right:1em}~ Save your current work. It will be saved using whatever name is shown in the **Script name** box below the buttons. If this box is empty you will be prompted for a name. Files all have ~m:.json~ extensions; if this is omitted it will be added.
1414

15-
~img:resources/icon/trash.png:{float:left;height:2em;margin-right:1em}~ Delete the current presentation. You will be prompted to confirm before the delete goes ahead.
15+
~img:https://easycoder.github.io/iwsy/resources/icon/trash.png|{float:left;height:2em;margin-right:1em}~ Delete the current presentation. You will be prompted to confirm before the delete goes ahead.
1616

17-
~img:resources/icon/fileman.png:{float:left;height:2em;margin-right:1em}~ Open the image manager. This shows you all the images you have uploaded to our server. If you are not registered, this button is non-operational.
17+
~img:https://easycoder.github.io/iwsy/resources/icon/fileman.png|{float:left;height:2em;margin-right:1em}~ Open the image manager. This shows you all the images you have uploaded to our server. If you are not registered, this button is non-operational.
1818

19-
~img:resources/icon/run.png:{float:left;height:2em;margin-right:1em}~ Run your presentation. A player is created in the spacce currently occupied by this Help page and the presentation runs without manual intervention. The button changes to ~img:resources/icon/runstop.png:icon~. If you click this the presentation will stop.
19+
~img:https://easycoder.github.io/iwsy/resources/icon/run.png|{float:left;height:2em;margin-right:1em}~ Run your presentation. A player is created in the spacce currently occupied by this Help page and the presentation runs without manual intervention. The button changes to ~img:https://easycoder.github.io/iwsy/resources/icon/runstop.png|icon~. If you click this the presentation will stop.
2020

21-
~img:resources/icon/fullscreen.png:{float:left;height:2em;margin-right:1em}~ Run your presentation in full-screen mode. This is the mode you will use when connected to an overhead projector, for example.
21+
~img:https://easycoder.github.io/iwsy/resources/icon/fullscreen.png|{float:left;height:2em;margin-right:1em}~ Run your presentation in full-screen mode. This is the mode you will use when connected to an overhead projector, for example.
2222

2323
In fullscreen mode the presentation waits for a mouse click or a button press. A mouse click or either of the space or right-arrow keys will cause the presentation to start in manual mode, where it stops after each visual change and waits for you to click or press again. If you press the Enter key the presentation will run according to the timing given by its individual steps. You can interrupt this my clicking or by pressing space or right-arrow.
2424

2525
In some cases the browser will report the screen size incorrectly and some backgrounds will not show properly; if this happens it's best to select full-screen mode in your browser before clicking this button.
2626

27-
~img:resources/icon/help.png:{float:left;height:2em;margin-right:1em}~ Display this help at the page you were last viewing.
27+
~img:https://easycoder.github.io/iwsy/resources/icon/help.png|{float:left;height:2em;margin-right:1em}~ Display this help at the page you were last viewing.
2828

29-
~img:resources/icon/trash.png:{float:left;height:2em;margin-right:1em}~ Login or Register. This displays the ~page:users:Login panel~.
29+
~img:https://easycoder.github.io/iwsy/resources/icon/trash.png|{float:left;height:2em;margin-right:1em}~ Login or Register. This displays the ~page:users:Login panel~.

iwsy/resources/help/img/pause.png

13 KB
Loading

iwsy/resources/help/img/project.png

791 Bytes
Loading
24.5 KB
Loading
17.4 KB
Loading

iwsy/resources/help/project.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
# The Project panel
44

5-
The right-hand side of the screen holds the Project panel. When you start up - or after you click the ~img:resources/users/2020/160/1/images/help/new.png:icon~(New) button - it looks like this:
6-
~img:resources/users/2020/160/1/images/help/project.png:100%~
5+
The right-hand side of the screen holds the Project panel. When you start up - or after you click the ~img:https://easycoder.github.io/iwsy/resources/icon/new.png|icon~(New) button - it looks like this:
6+
~img:https://easycoder.github.io/iwsy/resources/help/img/project.png|100%~
77

88
There are 3 main sections.
99

0 commit comments

Comments
 (0)