Add documentation for rake tasks

docs/conf.py

@@ -28,9 +28,9 @@ copyright = u'2013-2017, AlphaNodes GmbH'
 author = u'Alexander Meindl'
 
 # The short X.Y version.
-version = u'2.0.5'
+version = u'2.0.6'
 # The full version, including alpha/beta/rc tags.
-release = u'2.0.5'
+release = u'2.0.6'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/index.rst

@@ -178,5 +178,6 @@ I am glad about your feedback on the plugin, `pull requests <https://github.com/
 
     manual
     macros
+    tasks
     new_feature
     changelog

docs/tasks.rst

@@ -0,0 +1,82 @@
+Tasks
+=====
+
+Additionals comes with some rake tasks, which can be used for administration.
+
+drop_settings
+-------------
+
+.. function:: rake redmine:additionals:drop_settings plugin=PLUGIN
+
+    Drop settings for a plugin
+
+    :param string plugin: name of the plugin
+
+Examples
+++++++++
+
+Remove plugin settings for redmine plugin named ``redmine_plugin_example``
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:drop_settings RAILS_ENV=production plugin="redmine_plugin_example"
+
+
+
+setting_set
+-----------
+
+.. function:: rake redmine:additionals:setting_set name=NAME setting=SETTING value=VALUE
+
+    Set settings for redmine or plugin
+
+    :param string name: name of the plugin or redmine (this is optional, if not defined redmine is used)
+    :param string setting: name of setting
+    :param string value: value for setting
+
+Examples
+++++++++
+
+Set application title for Redmine
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:setting_set RAILS_ENV=production name="additionals" setting="external_urls" value="2"
+
+Set plugin setting ``external_urls`` for plugin additionals to value 2
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:setting_set RAILS_ENV=production name="additionals" setting="external_urls" value="2"
+
+
+setting_get
+-----------
+
+.. function:: rake redmine:additionals:setting_get name=NAME setting=SETTING
+
+    Get a setting of redmine or a plugin
+
+    :param string name: name of the plugin or redmine (this is optional, if not defined redmine is used)
+    :param string setting: name of setting
+
+Examples
+++++++++
+
+Get setting for ``external_urls`` of the plugin additionals
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:setting_get RAILS_ENV=production name="additionals" setting="external_urls"
+
+Get ``app_title`` of redmine
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:setting_get RAILS_ENV=production name="redmine" setting="app_title"
+
+Get ``app_title`` of redmine
+
+.. code-block:: smarty
+
+  bundle exec rake redmine:additionals:setting_get RAILS_ENV=production setting="app_title"

lib/tasks/additionals.rake

@@ -23,7 +23,7 @@ namespace :redmine do
     Set settings.
 
     Example:
-      bundle exec rake redmine:additionals:set_setting RAILS_ENV=production name="additionals" setting="external_urls" value="2"
+      bundle exec rake redmine:additionals:setting_set RAILS_ENV=production name="additionals" setting="external_urls" value="2"
     DESCRIPTION
     task setting_set: :environment do
       name = ENV['name'] ||= 'redmine'
@@ -49,11 +49,11 @@ namespace :redmine do
     Get settings.
 
     Example for plugin setting:
-      bundle exec rake redmine:additionals:get_setting RAILS_ENV=production name="additionals" setting="external_urls"
+      bundle exec rake redmine:additionals:setting_get RAILS_ENV=production name="additionals" setting="external_urls"
     Example for redmine setting:
-      bundle exec rake redmine:additionals:get_setting RAILS_ENV=production name="redmine" setting="app_title"
+      bundle exec rake redmine:additionals:setting_get RAILS_ENV=production name="redmine" setting="app_title"
     Example for redmine setting:
-      bundle exec rake redmine:additionals:get_setting RAILS_ENV=production setting="app_title"
+      bundle exec rake redmine:additionals:setting_get RAILS_ENV=production setting="app_title"
     DESCRIPTION
     task setting_get: :environment do
       name = ENV['name'] ||= 'redmine'