rsence 2.0.9.23 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (74) hide show
  1. data/INSTALL.rdoc +61 -49
  2. data/README.rdoc +20 -4
  3. data/VERSION +1 -1
  4. data/conf/default_conf.yaml +8 -0
  5. data/conf/rsence_command_strings.yaml +31 -20
  6. data/docs/ExampleGuiPlugin.rdoc +2 -2
  7. data/js/comm/comm.js +27 -5
  8. data/js/comm/transporter/transporter.js +1 -1
  9. data/js/comm/values/values.js +12 -5
  10. data/js/controls/button/button.js +12 -2
  11. data/js/controls/dialogs/alert_sheet/alert_sheet.js +13 -1
  12. data/js/controls/dialogs/confirm_sheet/confirm_sheet.js +13 -2
  13. data/js/controls/dialogs/sheet/sheet.js +35 -28
  14. data/js/controls/imageview/imageview.js +13 -13
  15. data/js/controls/progress/progressindicator/progressindicator.js +5 -5
  16. data/js/controls/sliders/slider/slider.js +4 -31
  17. data/js/controls/stepper/stepper.js +12 -19
  18. data/js/controls/textcontrol/textcontrol.js +0 -50
  19. data/js/controls/textcontrol/themes/default/textcontrol.html +1 -1
  20. data/js/controls/window/window.js +1 -1
  21. data/js/core/elem/elem.js +146 -160
  22. data/js/core/rsence_ns/rsence_ns.js +7 -0
  23. data/js/foundation/control/eventresponder/eventresponder.js +8 -7
  24. data/js/foundation/eventmanager/eventmanager.js +81 -48
  25. data/js/foundation/geom/rect/rect.js +1 -1
  26. data/js/foundation/json_renderer/json_renderer.js +4 -1
  27. data/js/foundation/system/system.js +37 -34
  28. data/js/foundation/view/morphanimation/morphanimation.js +53 -43
  29. data/js/foundation/view/view.js +119 -118
  30. data/js/lists/listitems/listitems.js +10 -10
  31. data/js/lists/propertylist/js.inc +0 -0
  32. data/js/lists/propertylist/propertylist.js +574 -0
  33. data/js/lists/propertylist/propertylisteditor/js.inc +0 -0
  34. data/js/lists/propertylist/propertylisteditor/propertylisteditor.js +233 -0
  35. data/js/lists/radiobuttonlist/radiobuttonlist.js +15 -8
  36. data/js/menus/minimenu/js.inc +0 -0
  37. data/js/menus/minimenu/minimenu.js +139 -0
  38. data/js/menus/minimenu/minimenuitem/js.inc +0 -0
  39. data/js/menus/minimenu/minimenuitem/minimenuitem.js +33 -0
  40. data/js/menus/minimenu/minimenuitem/themes/default/minimenuitem.css +45 -0
  41. data/js/menus/minimenu/minimenuitem/themes/default/minimenuitem.html +4 -0
  42. data/js/menus/minimenu/minimenuitem/themes/default/minimenuitem_checkmark.png +0 -0
  43. data/js/menus/minimenu/themes/default/minimenu.css +63 -0
  44. data/js/menus/minimenu/themes/default/minimenu.html +7 -0
  45. data/js/menus/minimenu/themes/default/minimenu.png +0 -0
  46. data/js/util/reloadapp/reloadapp.js +1 -1
  47. data/lib/conf/argv.rb +40 -11
  48. data/lib/daemon/daemon.rb +63 -22
  49. data/lib/plugins/gui_plugin.rb +28 -31
  50. data/lib/plugins/guiparser.rb +37 -7
  51. data/lib/plugins/plugin.rb +260 -28
  52. data/lib/plugins/plugin_base.rb +14 -0
  53. data/lib/plugins/plugin_plugins.rb +11 -1
  54. data/lib/plugins/pluginmanager.rb +127 -44
  55. data/lib/plugins/plugins.rb +10 -1
  56. data/lib/session/msg.rb +25 -1
  57. data/lib/session/sessionmanager.rb +11 -2
  58. data/lib/session/sessionstorage.rb +14 -14
  59. data/lib/transporter/transporter.rb +29 -13
  60. data/lib/values/hvalue.rb +30 -0
  61. data/plugins/client_pkg/info.yaml +2 -2
  62. data/plugins/{index_html → main}/img/loading.gif +0 -0
  63. data/plugins/{index_html → main}/img/riassence.gif +0 -0
  64. data/plugins/main/info.yaml +5 -4
  65. data/plugins/main/main.rb +180 -24
  66. data/plugins/{index_html → main}/tmpl/index.html +4 -2
  67. data/plugins/ticket/info.yaml +2 -2
  68. data/plugins/ticket/lib/upload.rb +57 -5
  69. data/plugins/ticket/ticket.rb +10 -4
  70. data/setup/welcome/info.yaml +2 -2
  71. data/setup/welcome/text/welcome.html +1 -1
  72. metadata +22 -11
  73. data/plugins/index_html/index_html.rb +0 -120
  74. data/plugins/index_html/info.yaml +0 -18
data/INSTALL.rdoc CHANGED
@@ -4,21 +4,33 @@ If you already have a working ruby environment and know what to do, the easiest
4
4
 
5
5
  gem install rsence
6
6
 
7
- Otherwise, follow these instructions:
7
+ If you have an older version of rsence installed, it's be automatically
8
+ updated along other gems when you run:
8
9
 
10
+ gem update
9
11
 
10
- == 1. System Dependencies
12
+ For system-wide installs, run the gem command as a superuser. A common way
13
+ for doing so is prefixing the command with sudo.
14
+
15
+ RSence 2.1 is verified to be compatible with Rubinius. To use RSence with
16
+ Rubinius, just use "rbx gem" instead of just "gem" for installation.
17
+
18
+ The following instructions contain detailed steps for installing Ruby, RSence
19
+ and its dependencies on each supported platform:
20
+
21
+
22
+ == System Dependencies
11
23
 
12
24
  This is a list of system level dependencies. You only need to do this step once; follow the steps of for your target operating system.
13
25
 
14
- === 1.1. Mac OS X
26
+ === Mac OS X
15
27
 
16
- ==== 1.1.1 Mac OS X 10.6
28
+ ==== Mac OS X 10.6
17
29
 
18
30
  * Install *XCode*[http://developer.apple.com/mac/] to get the essential development tools, like compilers.
19
31
  * Proceed to section 3.0
20
32
 
21
- ==== 1.1.2. Mac OS X 10.4 and 10.5
33
+ ==== Mac OS X 10.4 and 10.5
22
34
 
23
35
  This step applies only to Mac OS X 10.4 "Tiger" and 10.5 "Leopard". The default ruby build of these versions of Mac OS X is somewhat broken.
24
36
 
@@ -29,7 +41,7 @@ This step applies only to Mac OS X 10.4 "Tiger" and 10.5 "Leopard". The default
29
41
  sudo port install rb-rubygems
30
42
  * Proceed to section 3.0
31
43
 
32
- === 1.2. Debian and Ubuntu Linux
44
+ === Debian and Ubuntu Linux
33
45
 
34
46
  This step applies only to Debian, Ubuntu and similar Linux distributions.
35
47
 
@@ -37,12 +49,12 @@ This step applies only to Debian, Ubuntu and similar Linux distributions.
37
49
  sudo apt-get install build-essential ruby-full rubygems rake
38
50
  * Proceed to section 3.0
39
51
 
40
- === 1.3. Microsoft Windows
52
+ === Microsoft Windows
41
53
 
42
54
  RSence works just fine on Windows too, with a few limitations.
43
55
  Windows compatibility has been officially tested on Windows XP SP3 and Windows 7 (64 bit).
44
56
 
45
- ==== 1.3.1. Install ruby 1.8.7:
57
+ ==== Install ruby 1.8.7:
46
58
  * Download Ruby 1.8.7-p249 (RC2) from http://rubyinstaller.org/downloads
47
59
  * Run the downloaded exe to install ruby
48
60
  * In the installation and destination prompt, check these options:
@@ -52,19 +64,19 @@ Windows compatibility has been officially tested on Windows XP SP3 and Windows 7
52
64
  * Extract the included directories into the directory where you installed ruby.
53
65
  * It's +C:\ruby+ by default.
54
66
 
55
- ==== 1.3.2. Install RSence
67
+ ==== Install RSence
56
68
  * In the command prompt, run:
57
69
  gem update --system
58
70
  gem install rsence
59
71
  rsence help
60
72
 
61
- ==== 1.3.3. Create RSence environment
73
+ ==== Create RSence environment
62
74
 
63
75
  Replace the +\my_projects+ path with the path to the directory where you want to run or develop your projects. Likewise, replace +my_project+ with something descriptive for your project.
64
76
 
65
77
  * In the command prompt, run:
66
78
  cd \my_projects
67
- rsence initenv my_project
79
+ rsence init my_project
68
80
  * Answer the questions
69
81
  * In the command prompt, run:
70
82
  rsence run my_project
@@ -72,7 +84,7 @@ Replace the +\my_projects+ path with the path to the directory where you want to
72
84
  * If the address is +0.0.0.0+, enter +127.0.0.1+ instead.
73
85
  * Using just defaults, the following URL should work: http://127.0.0.1:8001
74
86
 
75
- ==== 1.3.4. Windows limitations
87
+ ==== Windows limitations
76
88
  If you install the sqlite dll and the sqlite3-ruby gem, you'll gain persistent sessions and this warning message will disappear:
77
89
  `Warning: Session database is not available. Can't use persistent sessions`
78
90
 
@@ -83,7 +95,7 @@ Backgrounding on Windows is not yet implemented, because POSIX signals are not f
83
95
  However, if you run RSence under Cygwin, everything should work like on a UNIX machines.
84
96
 
85
97
 
86
- === 1.4. Other UNIX / Linux systems:
98
+ === Other UNIX / Linux systems:
87
99
 
88
100
  This step applies to systems not listed above.
89
101
 
@@ -98,13 +110,13 @@ You'll have to figure out how to install the dependencies on your own, but gener
98
110
  * gcc, make etc.
99
111
 
100
112
 
101
- == 2. Ruby Library Dependencies
113
+ == Ruby Library Dependencies
102
114
 
103
115
  The `rsence` gem depends on the dummy `rsence-deps` gem, which depends on all essential dependencies of RSence.
104
116
  Optionally, you probably want at a database and a database adapter supported by Sequel[http://sequel.rubyforge.org]
105
117
  This not only enables SessionStorage (persistent sessions between RSence restarts), but some plugins written for RSence depend on at least Sqlite.
106
118
 
107
- === 2.1 Detailed list of ruby libraries used
119
+ === Detailed list of ruby libraries used
108
120
 
109
121
  * *rake*[http://rake.rubyforge.org]
110
122
  * Ruby build tool
@@ -128,13 +140,13 @@ This not only enables SessionStorage (persistent sessions between RSence restart
128
140
  * A Sequel driver for your preferred database is also needed:
129
141
  * *sqlite3-ruby*:: SQLite[http://www.sqlite.org] is a light-weight SQL library. Recommended for development and small projects.
130
142
  * Other database adapters compatible with Sequel are fine. Just configure RSence accordingly.
131
- * *highline*:: Console-based menu prompt system by the initenv command.
143
+ * *highline*:: Console-based menu prompt system by the init command.
132
144
  * rmagick
133
145
  * Optional, but suggested, because RSence has RMagick -savvy features, like serving RMagick objects using tickets that are rendered only when requested.
134
146
  * Some plugins depend on it directly.
135
147
 
136
148
 
137
- == 3. Setting up RSence
149
+ == Setting up RSence
138
150
 
139
151
  The primary installation method of RSence is via RubyGems.
140
152
 
@@ -144,7 +156,7 @@ To ensure your RubyGems is up-to-date, run:
144
156
  Even if RubyGems is up-to-date, ensure your installed gems are up-to-date, some of these are updated frequently. This will also update RSence release versions to the most recent version, if installed.
145
157
  sudo gem update
146
158
 
147
- === 3.1. Install RSence
159
+ === Install RSence
148
160
 
149
161
  This will install RSence via RubyGems, the preferred method. All dependencies are installed too, except for the ones you already might have installed.
150
162
  gem install rsence
@@ -157,20 +169,20 @@ When installed, ensure it works by exploring the help of the 'rsence' command, l
157
169
  rsence help
158
170
  rsence help version
159
171
  rsence help run
160
- rsence help initenv
172
+ rsence help init
161
173
  etc..
162
174
 
163
- === 3.2. Setting up
175
+ === Setting up
164
176
 
165
- ==== 3.2.1. Creating a RSence project environment
177
+ ==== Creating a RSence project environment
166
178
 
167
- To set up an environment for your RSence project, use the initenv command. In this example '/home/me/projects' is assumed as your project directory. Replace that with a path that matches your own environment. The RSence project directory must either be empty or will be created automatically.
168
- rsence initenv /home/me/projects/my_first_rsence_project
179
+ To set up an environment for your RSence project, use the init command. In this example '/home/me/projects' is assumed as your project directory. Replace that with a path that matches your own environment. The RSence project directory must either be empty or will be created automatically.
180
+ rsence init /home/me/projects/my_first_rsence_project
169
181
 
170
- To see the options of the initenv command, use
171
- rsence help initenv
182
+ To see the options of the init command, use
183
+ rsence help init
172
184
 
173
- By default, initenv asks a few simple questions to write your configuration file. Just press enter, if you want to keep the suggested default options.
185
+ By default, init asks a few simple questions to write your configuration file. Just press enter, if you want to keep the suggested default options.
174
186
 
175
187
  The questions are:
176
188
  * Project Title
@@ -200,29 +212,29 @@ You may edit the conf/config.yaml at a later time to change these settings. The
200
212
 
201
213
  Any differences in your local configuration replace the default. If the configuration option type is an Array, the defaults are not replaced, the defaults are appended to. If your configuration only has partial items of a Hash defined, only those are applied to the default.
202
214
 
203
- ==== 3.2.2. Start RSence in the development mode with logs printed to the standard output:
215
+ ==== Start RSence in the development mode with logs printed to the standard output:
204
216
 
205
217
  The debug/development mode has the most verbose output and is the intended mode of RSence for development. Changes in your code are automatically (re)loaded and the javascript is not obfuscated or minimized in any way. Values also have human-readable id's.
206
218
  cd /home/me/projects/my_first_rsence_project
207
219
  rsence run -df
208
220
 
209
- ==== 3.3.3. Open a web browser
221
+ ==== Open a web browser
210
222
  * By default, the RSence listens on port 8001
211
223
  * To test it, open the address http://127.0.0.1:8001/
212
224
  * If everything works:
213
225
  * A welcome message is displayed
214
226
  * Check the "Don't show again" checkbox and click the "Close" button to make the 'welcome' plugin uninstall itself.
215
227
 
216
- ==== 3.3.4. Stop RSence
228
+ ==== Stop RSence
217
229
  Just press CTRL-C in the terminal, if RSence was started using the 'run' command.
218
230
 
219
231
 
220
- == 4. Modes of operation
232
+ == Modes of operation
221
233
 
222
234
  RSence supports two main modes of operation: in the foreground and in the background. Each have various options. Use the 'rsence help run' and 'rsence help start' commands to read more about them.
223
235
 
224
236
 
225
- === 4.1. Starting RSence as a foreground process.
237
+ === Starting RSence as a foreground process.
226
238
 
227
239
  The 'run' mode is well suited for development. Especially when combined with the -d and -f options.
228
240
 
@@ -238,26 +250,26 @@ Starting in foreground mode with debug and logging in foreground:
238
250
  Stopping in foreground mode: Press CTRL-C
239
251
 
240
252
 
241
- === 4.2. Starting RSence as a daemon (background mode).
253
+ === Starting RSence as a daemon (background mode).
242
254
 
243
255
  In the background mode, standard output and standard errors are logged in the 'log' directory of your project and the PID file is written in the 'run' directory. This mode of operation is best suited for production deployment and it's not available on Microsoft Windows, because full POSIX compliance is not available on Windows.
244
256
  rsence start
245
257
 
246
- === 4.2.1 Stopping RSence in background mode
258
+ === Stopping RSence in background mode
247
259
  rsence stop
248
260
 
249
- === 4.2.2 Checking RSence status in background mode
261
+ === Checking RSence status in background mode
250
262
  rsence status
251
263
 
252
- === 4.2.3 To store the RSence sessions into the session database while in background mode
264
+ === To store the RSence sessions into the session database while in background mode
253
265
  rsence save
254
266
 
255
267
  The sessions are also stored when stopping and restarting RSence. Use the 'save' command regularly from a cron script or equivalent in a production environment.
256
268
 
257
- === 4.3. Restarting RSence in background mode
269
+ === Restarting RSence in background mode
258
270
  rsence restart
259
271
 
260
- === 4.2.5. Re-setting the sessions
272
+ === Re-setting the sessions
261
273
  This is needed only, if the session storage becomes corrupt in a development environment (changing value definitions and such). This invalidates all ongoing sessions.
262
274
  Just apply the --reset-sessions option after the run, start or restart command in the command prompt.
263
275
  rsence restart --reset-sessions
@@ -267,11 +279,11 @@ The '-r' switch is equivalent to '--reset-sessions'
267
279
  *NOTE: All the sessions currently connected clients are invalidated and need to reload the page*
268
280
 
269
281
 
270
- === 4.4. Running in development mode
282
+ === Running in development mode
271
283
  Just apply the -d option after the *run*, *start* or *restart* command in the command prompt.
272
284
  rsence restart -d
273
285
 
274
- ==== 4.4.1. What does development mode do?
286
+ ==== What does development mode do?
275
287
  * Plugins are (re)loaded automatically in the background, if they are changed, disabled, added or removed.
276
288
  * This is also enabled with the -a switch (--auto-update)
277
289
  * Javascript packages are automatically re-built, if they are changed.
@@ -279,22 +291,22 @@ Just apply the -d option after the *run*, *start* or *restart* command in the co
279
291
  * Much more verbose logging
280
292
  * Code obfuscation / minimizing options are turned off.
281
293
 
282
- === 4.5. Other command-line options
294
+ === Other command-line options
283
295
  Just run this command to see the available options:
284
296
  rsence help <command>
285
297
  example:
286
298
  rsence help run
287
299
 
288
- === 4.6. Running RSence using rackup
300
+ === Running RSence using rackup
289
301
  rackup conf/config.ru
290
302
 
291
- === 4.7. Running RSence using unicorn
303
+ === Running RSence using unicorn
292
304
  unicorn conf/config.ru -c conf/unicorn.conf
293
305
 
294
306
 
295
- == 5. Plugin Deployment
307
+ == Plugin installation
296
308
 
297
- If you followed the previous steps, you are ready to deploy some software.
309
+ If you followed the previous steps, you are ready to install some plugins.
298
310
  * In development mode (see 4.4.), plugins are (re/un)loaded when:
299
311
  * Adding a new plugin into the plugins directory
300
312
  * Removing a plugin from the plugins directory
@@ -302,25 +314,25 @@ If you followed the previous steps, you are ready to deploy some software.
302
314
  * Enabling a plugin by removing a file or folder named "disabled" in the plugin's bundle directory
303
315
  * The plugin's ruby or yaml files are changed.
304
316
 
305
- * In production mode, a RSence restart is required (see 4.4.), unless running with the '-a' ('--auto-update') option enabled. Enabling it is a good idea for production environments where the code is updated frequently. It enables nearly zero downtime, if code updates are thoroughly tested before being deployed.
317
+ * In production mode, a RSence restart is required (see 4.4.), unless running with the '-a' ('--auto-update') option enabled. Enabling it is a good idea for production environments where the code is updated frequently. It enables nearly zero downtime, if code updates are thoroughly tested before being upgraded.
306
318
 
307
319
  * By default, the "plugins" directory in the "rsence" directory is the only plugin directory.
308
320
  * Edit the configuration file to enable other directories.
309
321
  * Sample plugins are available at http://rsence.org/
310
322
 
311
323
 
312
- === 5.1. Deploying plugins
324
+ === Installing plugins
313
325
  Copy or move a plugin bundle directory into the "plugins" directory.
314
326
 
315
- === 5.2. Un-deploying plugins
327
+ === Un-Installing plugins
316
328
  Move a plugin bundle out of the the "plugins" directory.
317
329
 
318
- === 5.3. Temporarily disabling a plugin
330
+ === Temporarily disabling a plugin
319
331
  Create an empty file named "disabled" in the plugin bundle to disable it.
320
332
  touch plugins/legacy/disabled
321
333
 
322
334
 
323
- == 6. Getting more information
335
+ == Getting more information
324
336
 
325
337
  * Explore http://rsence.org/
326
338
  * Join our chat room on IRC (IRCNet and FreeNode):
data/README.rdoc CHANGED
@@ -1,11 +1,11 @@
1
1
 
2
- = RSence-2.0.0[http://rsence.org/]
2
+ = RSence-2.1.0[http://rsence.org/]
3
3
 
4
4
  == Introduction
5
5
 
6
6
  RSence is a RIA framework designed for responsive GUI applications on the web; it's implemented as a hybrid Ruby - Javascript system. The server is written in Ruby and C. Applications are installed as plugin bundles. The GUI framework is written in Javascript; it doesn't strictly require the server, but has extensive transport support with automatic data synchronization with the server. User interfaces are usually described in structured view trees represented by YAML data structures, which are automatically converted for rendering in the client.
7
7
 
8
- Javascript knowledge is required only when creating custom client-driven functionality; basic understanding of the YAML GUITree structures is enough in most cases. Likewise, no Ruby knowledge is needed if you want to create stand-alone Javascript applitations. Javascript component themes are easily created with just basic web designer skills. Data API's are easy to link no matter what language is used to create them. Skills in your organization are easily combined for various parts of larger applications.
8
+ Javascript knowledge is required only when creating custom client-driven functionality; basic understanding of the YAML GUITree structures is enough in most cases. Likewise, no prior Ruby knowledge is needed if you want to create stand-alone Javascript applitations. Javascript component themes are easily created with just basic web designer skills. Data API's are easy to link no matter what language is used to create them. Skills in your organization are easily combined for various parts of larger applications.
9
9
 
10
10
  RSence is not primarily targeted as an engine for plain old html web sites, there are plenty of other tools for that purpose and RSence is easily integrated with them in various ways.
11
11
 
@@ -17,8 +17,8 @@ Just run this command in the shell, if you have ruby installed. Otherwise, read
17
17
 
18
18
  == Initializing a new project
19
19
 
20
- The +initenv+ command will cretate a directory called `env_dir` in this example. It asks a few questions about the environment. Use a path and project name that matches your purposes.
21
- rsence initenv /home/me/rsence_projects/env_dir
20
+ The +init+ command will cretate a directory called `env_dir` in this example. It asks a few questions about the environment. Use a path and project name that matches your purposes.
21
+ rsence init /home/me/rsence_projects/env_dir
22
22
 
23
23
 
24
24
  == Project environment structure
@@ -87,6 +87,22 @@ Each command-line tool command takes a number of options, the +env_dir+ argument
87
87
 
88
88
  For more detailed installation and usage instructions, read the {file:INSTALL Install Guide} document.
89
89
 
90
+ === The bleeding edge (for developers)
91
+ RSence comes in two varieties:
92
+ 1. rsence : The stable (no major new featuers, just bugfixes) release.
93
+ 2. rsence-pre : The active development snaphot released periodically.
94
+
95
+ Both varieties can be installed simultaneously and it's suggested to use
96
+ the stable "rsence" package for production installations and to use the
97
+ "rsence-pre" package for development purposes, because the RSence crew
98
+ can't possibly test each and every application available. It's your
99
+ responsibility as a developer to report any RSence issues effecting your
100
+ software. The sooner reported, the better; it ensures better release
101
+ versions.
102
+
103
+ To use "rsence-pre", install the "rsence-pre" gem and use the "rsence-pre"
104
+ command instead of the "rsence" command.
105
+
90
106
  === Licensing and commercial support options
91
107
  * {file:LICENSE.txt *GPL*} version 3 by default.
92
108
  * Riassence[http://riassence.com/] Inc. provides commercial support, custom licensing arrangements and various other services.
data/VERSION CHANGED
@@ -1 +1 @@
1
- 2.0.9.23
1
+ 2.1.0
@@ -81,6 +81,9 @@
81
81
  #
82
82
  # The HApplication priority of the client, when actively polling.
83
83
  :client_poll_priority: 60
84
+ #
85
+ # Reload the client after any plugins are reloaded:
86
+ :client_autoreload: false
84
87
  #
85
88
  #
86
89
  # Session-related settings
@@ -287,6 +290,10 @@
287
290
  - listitems # HListItems
288
291
  - checkboxlist # HCheckboxList
289
292
  - radiobuttonlist # HRadiobuttonList
293
+ - propertylist # HPropertyList
294
+ - propertylisteditor # HPropertyEditor
295
+ - minimenu # HMiniMenu
296
+ - minimenuitem # HMiniMenuItem
290
297
 
291
298
  # Special packages that include other packages (not used currently)
292
299
  :compound_packages:
@@ -301,6 +308,7 @@
301
308
  # with a underscore that should not be obfuscated
302
309
  :reserved_names:
303
310
  - _ID
311
+ - _id
304
312
  - _WIDTH
305
313
  - _width
306
314
  - _HEIGHT
@@ -46,7 +46,7 @@
46
46
  Invalid environment: <%%= env_path.inspect %>
47
47
 
48
48
  Type 'rsence help <%%= @cmd.to_s %>' for usage."
49
- Type 'rsence help initenv' for environment initialization usage."
49
+ Type 'rsence help init' for environment initialization usage."
50
50
  :invalid_option_chr: |
51
51
  Invalid option character for option character block <%%= arg.inspect %>:
52
52
  <%%= chr.inspect %>
@@ -79,7 +79,7 @@
79
79
  No process running.
80
80
  :session_data_saved: |
81
81
  Session data saved.
82
- # Strings for the initenv command
82
+ # Strings for the init command
83
83
  :initenv:
84
84
  :env_already_initialized: |
85
85
  Environment already initialized.
@@ -171,6 +171,7 @@
171
171
 
172
172
  :confirm_config: "Is the configuration correct, "
173
173
  :creating_dirs: "Creating directories..."
174
+ :install_welcome: "Do you want to install the 'welcome' plugin as a starting point, "
174
175
  :installing_welcome_plugin: |+
175
176
  Installing the welcome plugin. To remove it, just delete this folder:
176
177
  <%%= welcome_plugin_dst %>
@@ -278,9 +279,19 @@
278
279
  'say' command installed.
279
280
 
280
281
  :initenv: |+
281
- usage: 'rsence initenv [options] [PATH]'
282
+ Alias name of the 'init' command.
283
+
284
+ See: rsence help init
285
+
286
+ :initialize: |+
287
+ Alias name of the 'init' command.
288
+
289
+ See: rsence help init
282
290
 
283
- The 'initenv' command creates a new RSence environment.
291
+ :init: |+
292
+ usage: 'rsence init [options] [PATH]'
293
+
294
+ The 'init' command creates a new RSence environment.
284
295
 
285
296
  The expected structure of a project environment (where 'project_directory'
286
297
  is the directory of your project) is:
@@ -410,35 +421,35 @@
410
421
 
411
422
  :version: |+
412
423
  usage: 'rsence version'
413
-
424
+
414
425
  The 'version' command simply outputs the version number of RSence.
415
-
416
- RSence follows the standard four-numbered sequence-based version identification
417
- scheme. The scheme is defined like: major.minor[.maintenance[.package]][.pre]
418
-
426
+
427
+ RSence follows the common three-numbered sequence-based version identification
428
+ scheme. The scheme is defined like: major.minor[.maintenance]
429
+
419
430
  The major number designates major changes in functionality, sometimes limiting
420
431
  backwards compatibility with software written for previous versions.
421
-
432
+
422
433
  The minor number designates minor changes in functionality, like minor or
423
434
  moderate changes in functionality that usually don't impact backwards
424
435
  compatibilty of software written for a previous release with the same major
425
436
  version.
426
-
437
+
427
438
  The maintenance number designates bug fixes and other minimal changes to
428
439
  the release. In a maintenance number change, no new features are introduced.
429
-
440
+
430
441
  The package number is a sequence used for the package release. Rubygems
431
442
  requires an unique version for each gem released, so pre-releases usually
432
443
  occupy the first package numbers of any release.
433
-
434
- The '.pre' suffix signifies a pre-release, like "Alpha" or "Beta". To
435
- install a prerelease version, gem requires the '--pre' command line argument.
436
- Release versions never have the '.pre' suffix. There are usually several
437
- package number increments of a new release.
438
-
444
+
445
+ RSence also comes in a '-pre' variety. Consider RSence prereleases as
446
+ anything between 'Alpha', 'Beta' and 'Release Candidate'. The prereleases
447
+ are have a fourth number in their version number string. That number
448
+ is the 'package' or 'build' number.
449
+
439
450
  Version number conventions in written text should include both major and
440
451
  minor version numbers prefixed with 'RSence'. The maintennance number
441
452
  is usally not mentioned unless an issue is fix or such is discussed.
442
-
443
- For instance: "RSence 2.0 has undergone some major refactoring since 1.2.1"
453
+
454
+ Example: "RSence 2.0 has undergone some major refactoring since 1.2.1"
444
455