drg_cms 0.4.61 → 0.5.0

data/app/helpers/dc_application_helper.rb

@@ -47,6 +47,15 @@ attr_reader :options
 # all parts read from page, design, ...
 attr_accessor :parts
 
+
+############################################################################
+# When @parent is present then helper methods are called from parent class otherwise 
+# from self. 
+############################################################################
+def _origin #:nodoc:
+  @parent ? @parent : self  
+end
+
 ############################################################################
 # This is main method used for render parts of design into final HTML document.
 # 
@@ -142,11 +151,13 @@ end
 def dc_edit_title()
   title = @form['form']['title']
 # defined as form:title:edit
-  if title and title['edit']
+  if title and title['edit'] and !@form['readonly']
     t( title['edit'], title['edit'] )
+  elsif title and title['show'] and @form['readonly']
+    t( title['show'], title['show'] )
   else
 # concatenate title 
-    c = "#{t('drgcms.edit')} : "
+    c = (@form['readonly'] ? t('drgcms.show') : t('drgcms.edit')) + " : "
     c << (@form['title'] ? t( @form['title'], @form['title'] ) : t_tablename(@form['table'])) + ' : '
     title = (title and title['field']) ? title['field'] : @form['form']['edit_title']
     c << "#{@record[ title ]} : " if title and @record.respond_to?(title)
@@ -191,6 +202,51 @@ eot
   c.html_safe
 end
 
+############################################################################
+# Similar to rails submit_tag, but also takes care of link icon, translation, ...
+############################################################################
+def dc_submit_tag(caption, icon, parms, rest={})
+  parms['class'] ||= 'dc-submit'
+  if icon
+    icon_image = if icon.match(/\./)
+      image_tag(icon, class: 'dc-animate')
+    elsif icon.match('<i')
+      icon
+    else
+      fa_icon(icon)
+    end
+  end
+  html = icon_image || ''
+  html << submit_tag(t(caption, caption), parms)
+end
+############################################################################
+# Similar to rails link_to, but also takes care of link icon, translation, ...
+############################################################################
+def dc_link_to(caption, icon, parms, rest={})
+  if parms.class == Hash
+    parms.stringify_keys!
+    rest.stringify_keys!
+    rest['class'] = rest['class'].to_s + ' dc-animate'
+    rest['target'] ||=  parms.delete('target')
+  end
+#  
+  if icon
+    icon_image = if icon.match(/\./)
+      _origin.image_tag(icon, class: 'dc-link-img dc-animate')
+    elsif icon.match('<i')
+      icon
+    else
+      _origin.fa_icon(icon)
+    end
+  end
+#  
+  if caption
+    caption = t(caption, caption)
+    icon_image << ' ' if icon_image
+  end
+  _origin.link_to("#{icon_image}#{caption}".html_safe, parms, rest)  
+end
+
 ####################################################################
 # Returns flash messages formatted for display on message div.
 # 
@@ -198,27 +254,21 @@ end
 # String. HTML code formatted for display.
 ####################################################################
 def dc_flash_messages()
-  err  = @parent ? @parent.flash[:error]   : flash[:error]
-  war  = @parent ? @parent.flash[:warning] : flash[:warning]
-  inf  = @parent ? @parent.flash[:info]    : flash[:info]
-  note = @parent ? @parent.flash[:note]    : flash[:note]
+  err  = _origin.flash[:error]
+  war  = _origin.flash[:warning]
+  inf  = _origin.flash[:info]
+  note = _origin.flash[:note]
   unless err.nil? and war.nil? and inf.nil? and note.nil?
     c = ''
     c << "<div class=\"dc-form-error\">#{err}</div>" if err
     c << "<div class=\"dc-form-warning\">#{war}</div>" if war
     c << "<div class=\"dc-form-info\">#{inf}</div>" if inf
     c << note if note
-    if @parent 
-      @parent.flash[:error]   = nil
-      @parent.flash[:warning] = nil
-      @parent.flash[:info]    = nil
-      @parent.flash[:note]    = nil
-    else
-      flash[:error]   = nil
-      flash[:warning] = nil
-      flash[:info]    = nil
-      flash[:note]    = nil
-    end
+    _origin.flash[:error]   = nil
+    _origin.flash[:warning] = nil
+    _origin.flash[:info]    = nil
+    _origin.flash[:note]    = nil
+
     c.html_safe
   end
 end
@@ -280,7 +330,7 @@ end
 # Boolean. True if in edit mode
 ####################################################################
 def dc_edit_mode?
-  (@parent ? @parent.session[:edit_mode] : session[:edit_mode]) > 1
+  _origin.session[:edit_mode] > 1
 end
 
 ####################################################################
@@ -300,18 +350,14 @@ end
 # String. HTML code which includes add image and javascript to invoke new document create action.
 ####################################################################
 def dc_link_for_create(opts)
-  title = opts.delete(:title) #
+  opts.stringify_keys!  
+  title = opts.delete('title') #
   title = t(title, title) if title
-  target = opts.delete(:target)  || 'iframe_cms'
-  opts[:action] = 'new'
-  url   = @parent ? @parent.url_for(opts) : url_for(opts)
-  js = "$('##{target}').attr('src', '#{url}'); return false;"
-  html = if @parent
-    @parent.image_tag('drg_cms/add.png', { onclick: js, style: 'cursor: pointer;', title: title, alt: 'Create'})
-  else
-    image_tag('drg_cms/add.png', { onclick: js, style: 'cursor: pointer;', title: title, alt: 'Create'})
-  end
-  html.html_safe  
+  target = opts.delete('target')  || 'iframe_cms'
+  opts['action'] = 'new'
+  js = "$('##{target}').attr('src', '#{_origin.url_for(opts)}'); return false;"
+  dc_link_to(nil, _origin.fa_icon('plus-circle lg', class: 'dc-inline-link'), '#',
+             { onclick: js, title: title, alt: 'Create'}).html_safe
 end
 
 ####################################################################
@@ -328,19 +374,14 @@ end
 # String. HTML code which includes edit image and javascript to invoke edit document action.
 ####################################################################
 def dc_link_for_edit(opts)
-  title = opts.delete(:title) #
-  title = t(title, title) if title
-  target = opts.delete(:target) || 'iframe_cms'
-  opts[:action] = 'edit'
-  opts[:controller] ||= 'cmsedit'
-  url   = @parent ? @parent.url_for(opts) : url_for(opts)
-  js = "$('##{target}').attr('src', '#{url}'); return false;"
-  html = if @parent
-    @parent.image_tag('drg_cms/edit.png', { onclick: js, style: 'cursor: pointer;', title: title, alt: 'Edit'})
-  else
-    image_tag('drg_cms/edit.png', { onclick: js, style: 'cursor: pointer;', title: title, alt: 'Edit'})
-  end
-  html.html_safe
+  opts.stringify_keys!  
+  title  = opts.delete('title') #
+  target = opts.delete('target') || 'iframe_cms'
+  opts['action'] = 'edit'
+  opts['controller'] ||= 'cmsedit'
+  js  = "$('##{target}').attr('src', '#{_origin.url_for(opts)}'); return false;"
+  dc_link_to(nil, _origin.fa_icon('edit lg', class: 'dc-inline-link'), '#', 
+             { onclick: js, title: title, alt: 'Edit'})
 end
 
 ####################################################################
@@ -349,7 +390,8 @@ end
 def dc_link_menu_tag(title) #:nodoc:
   html =<<EOT
   <dl>
-  <dt><div class='drgcms_popmenu' href="#"><span><img style="cursor:pointer;" src="/assets/drg_cms/edit.png" title="#{title}"></span></div></dt>
+  <dt><div class='drgcms_popmenu' href="#">
+   #{_origin.fa_icon('edit lg', class: 'dc-inline-link', title: title)}</div></dt>
     <dd>
     <ul class=' div-hidden drgcms_popmenu_class'> 
 EOT
@@ -361,8 +403,10 @@ end
 # Create one option in page edit link. Subroutine of dc_page_edit_menu.
 ####################################################################
 def dc_link_for_edit1(opts, link_text) #:nodoc:
-  url = @parent.url_for(opts)
-  "<li><div class='drgcms_popmenu_item' style='cursor: pointer;' data-url='#{url}'>#{link_text}</div></li>\n"
+  icon = opts.delete('icon')
+  url  = @parent.url_for(opts)
+  "<li><div class='drgcms_popmenu_item' style='cursor: pointer;' data-url='#{url}'>
+#{_origin.fa_icon(icon)} #{link_text}</div></li>\n"
 end
 
 ########################################################################
@@ -396,17 +440,20 @@ def dc_page_edit_menu(opts=@opts)
   @parent.cookies[:record] = Marshal.dump(kukis)
   title = "#{t('drgcms.edit')}: #{@page.subject}"
   dc_link_menu_tag(title) do |html|
-    opts[:editparams].merge!( :controller => 'cmsedit', :action => 'edit' )
+    opts[:editparams].merge!( controller: 'cmsedit', action: 'edit', 'icon' => 'edit' )
     opts[:editparams].merge!( :id => @page.id, :table => @parent.site.page_table, formname: nil, edit_only: 'body' )
     html << dc_link_for_edit1( opts[:editparams], t('drgcms.edit_content') )
     
-    opts[:editparams][:edit_only] = nil
+#    opts[:editparams][:edit_only] = nil
+    opts[:editparams].merge!( edit_only: nil, 'icon' => 'pencil' )
     html << dc_link_for_edit1( opts[:editparams], t('drgcms.edit_advanced') )
     
-    opts[:editparams][:action] = 'new'
+#    opts[:editparams][:action] = 'new'
+    opts[:editparams].merge!( action: 'new', 'icon' => 'plus' )
     html << dc_link_for_edit1( opts[:editparams], t('drgcms.edit_new_page') )
 
-    opts[:editparams].merge!(ids: @page.id, formname: 'dc_part', table: "#{@parent.site.page_table};dc_part"  )
+    opts[:editparams].merge!(ids: @page.id, formname: 'dc_part', 'icon' => 'plus-square-o', 
+                             table: "#{@parent.site.page_table};dc_part"  )
     html << dc_link_for_edit1( opts[:editparams], t('drgcms.edit_new_part') )
   end
 end
@@ -594,7 +641,7 @@ end
 def dc_get_site()
   return @site if @site # already cached
 #
-  req = @parent ? @parent.request.url : request.url # different when called from renderer
+  req = _origin.request.url # different when called from renderer
   uri  = URI.parse(req)
   @site = DcSite.find_by(name: uri.host)
 # Site can be aliased
@@ -859,12 +906,8 @@ end
 # Boolean. True if user has required role.    
 ####################################################################
 def dc_user_has_role( role, user=nil, roles=nil )
-  if roles.nil?
-    roles = (@parent ? @parent.session : session)[:user_roles]
-  end
-  if user.nil?
-    user = (@parent ? @parent.session : session)[:user_id]
-  end
+  roles = _origin.session[:user_roles] if roles.nil?
+  user  = _origin.session[:user_id] if user.nil?
   return false if user.nil?  
 #  
   if role.class == String
@@ -891,7 +934,7 @@ end
 ####################################################################
 def dc_dont?(what, default=false)
   return default if what.nil?
-  %w(0 no - false).include?(what.to_s.downcase.strip)
+  %w(0 no - false none).include?(what.to_s.downcase.strip)
 end
 
 ############################################################################

data/app/models/drgcms_form_fields.rb

@@ -30,7 +30,7 @@
 # 
 # Each class must have at least render method implemented. All classes can
 # inherit from DrgcmsField class which acts as abstract template class and implements 
-# most of surrounding code.
+# most of surrounding code for creating custom DRG CMS form field.
 # 
 # Render method must create html and javascript code which must be
 # saved to internal @html and @js variables. Field code is then retrived by accessing
@@ -58,7 +58,7 @@ module DrgcmsFormFields
 
 ###########################################################################
 # Template method for DRG CMS form field definition. This is abstract class with
-# most of the common code already implemented.
+# most of the common code for custom form field already implemented.
 ###########################################################################
 class DrgcmsField
 attr_reader :html, :js
@@ -137,7 +137,7 @@ end
 # Parameters:
 # [Hash] Hash. Ruby hash parameters.
 # 
-# Example: As used in forms
+# Form example: As used in forms
 #    options:
 #      height: 400
 #      width: 800
@@ -190,6 +190,25 @@ end
 # Implementation of readonly DRG CMS form field. 
 # 
 # Readonly field value is just painted on form.
+# 
+# ===Form options:
+# * +name:+ field name
+# * +type:+ readonly
+# * +eval:+ value will be provided by evaluating expression. Usually dc_name4_id helper
+# can be used to get value. Example: dc_name4_id,model_name_in_lower_case,field_name 
+# 
+# * +readonly:+ yes (can be applied to any field type)
+# 
+# Form example:
+#    10:
+#      name: user
+#      type: readonly
+#      html:
+#        size: 50
+#    20:
+#      name: created_by
+#      type: readonly
+#      eval: dc_name4_id,dc_user,name
 ###########################################################################
 class Readonly < DrgcmsField
 ###########################################################################
@@ -218,6 +237,15 @@ end
 # Implementation of hidden DRG CMS form field.
 # 
 # Will create hidden_field on form.
+# 
+# ===Form options:
+# * +name:+ field name
+# * +type:+ hidden_field
+# 
+# Form example:
+#    10:
+#      name: im_hidden
+#      type: hidden_field
 ###########################################################################
 class HiddenField < DrgcmsField
 ###########################################################################
@@ -235,6 +263,22 @@ end
 # Implementation of embedded DRG CMS form field.
 #
 # Creates html required to paint embedded object on form.
+# 
+# ===Form options:
+# * +name:+ field name (required)
+# * +type:+ embedded (required)
+# * +formname:+ name of form which will be used for editing
+# * +html:+ html options (optional)
+#   * +height:+ height of embedded object in pixels (1000)
+#   * +width:+ width of embedded object in pixels (500)
+# 
+# Form example:
+#    10:
+#      name: dc_parts
+#      type: embedded
+#      formname: dc_part
+#      html:
+#        height: 1000
 ###########################################################################
 class Embedded < DrgcmsField
 ###########################################################################
@@ -269,9 +313,19 @@ end
 end
 
 ###########################################################################
-# Implementation of journal_diff DRG CMS form field.
+# Implementation of journal_diff DRG CMS form field. journal_diff field is used to 
+# show differences between two fields in DcJournal collection.
 # 
-# journal_diff field is used to show differences between two fields in DcJournal collection.
+# ===Form options:
+# * +name:+ field name (required)
+# * +type:+ journal_diff (required)
+# 
+# Form example:
+#    10:
+#      name: diff
+#      type: journal_diff
+#      html:
+#        size: 100x25
 ###########################################################################
 class JournalDiff < DrgcmsField
 ###########################################################################
@@ -298,15 +352,23 @@ end
 # id's of selected documents and control typically displays value of the field name 
 # defined by search options.
 # 
-# Form options:
-# [name] field name
-# [table] Collection (table) name
-# [search] Search may consist of three parameters from which last is not required. Parameters
-# can be separated either by dot (.) or comma(,) table_name.display_field_name.(table_name_search_method)
-# table_name is name of collection, display_field_name will be used for displaying value of selected
-# document ids on screen. Optional search method can be defined when searched documents are 
-# only subset of all documents and additional query is required.
-# [html] Various html options which can be applied to input object.
+# ===Form options:
+# * +name:+ field name (required)
+# * +type:+ multitext_autocomplete (required)
+# * +table+ Collection (table) name. When defined search must contain field name
+# * +search:+ Search may consist of three parameters from which are separated either by dot (.) or comma(,)
+#   * search_field_name; when table option is defined search must define field name which will be used for search query
+#   * collection_name.search_field_name; Same as above except that table options must be ommited.
+#   * collection_name.search_field_name.method_name; When searching is more complex custom search
+#   method may be defined in CollectionName model which will provide result set for search.
+#      
+# Form example:
+#      90:
+#        name: kats
+#        type: multitext_autocomplete
+#        search: dc_category.name      
+#        html:
+#          size: 30
 ###########################################################################
 class MultitextAutocomplete < DrgcmsField
 
@@ -447,22 +509,37 @@ end
 ###########################################################################
 # Implementation of select DRG CMS form field.
 # 
-# Form options:
-# [name] field name
-# [choices] Values for choices separated by comma. Values can also be specified like description:value.
-# In this case description will be shown to user, but value will be saved to document.
+# ===Form options:
+# * +name:+ field name (required)
+# * +type:+ select (required)
+# * +choices:+ Values for choices separated by comma. Values can also be specified like description:value.
+# In the example description will be shown to user, but value will be saved to document.
 #    choices: 'OK:0,Ready:1,Error:2'
 #    choices: Ruby,Pyton,PHP
-# [eval] Choices will be provided by evaluating expression 
-#    eval: dc_choices4('model_name','description_field_name','_id') # call dc_choices4 method
-#    eval: DcPolicyRole.choices4_roles # call class method choices4_roles in DcPolicyRole class definition.
-# If choices or eval is not defined choices will be provided from translation helpers. If you have
-# field status on a form choices may be provided by en.helpers.model_name.choices4_status entry of
-# english translation. English is of course default translation. If you provide translations in
-# your own language then select choices will be localized.
+# * +eval:+ Choices will be provided by evaluating expression
+#   * eval: dc_choices4('model_name','description_field_name','_id'); dc_choices4 helper will provide data for select field. 
+#   * eval: ModelName.choices4_field; ModelName class will define method choices4_field which 
+#   will provide data for select field.
+#   * collection_name.search_field_name.method_name; When searching is more complex custom search
+#   method may be defined in CollectionName model which will provide result set for search.
+# * If choices or eval is not defined choices will be provided from translation helpers. For example: 
+#   Collection has field status choices for field may be provided by en.helpers.model_name.choices4_status 
+#   entry of english translation. English is of course default translation. If you provide translations in
+#   your local language then select choices will be localized.
+#    en.helpers.model_name.choices4_status: 'OK:0,Ready:1,Error:2'
 #    sl.helpers.model_name.choices4_status: 'V redu:0,Pripravljen:1,Napaka:2'
-#     
-# [html] html options which can be applied to select field.
+# * +html:+ html options which apply to select field (optional)
+#      
+# Form example:
+#    30:
+#      name: type
+#      type: select
+#    40:
+#      name: parent
+#      type: select
+#      eval: DcCategory.values_for_parent
+#      html:
+#        include_blank: true      
 ###########################################################################
 class Select < DrgcmsField
   
@@ -537,6 +614,23 @@ end
 
 ###########################################################################
 # Implementation of check_box DRG CMS form field.
+# 
+# ===Form options:
+# * +name:+ field name (required)
+# * +type:+ check_box (required)
+# * +choices:+ Values check_box separated by comma (1,0) (yes,no)
+# * +checked_value:+ 1 or yes or approved
+# * +unchecked_value:+ 0 or no or not approved
+# * +html:+ html options which apply to check_box field (optional)
+#      
+# Form example:
+#    30:
+#      name: active
+#      type: check_box
+#    40:
+#      name: status
+#      type: check_box
+#      choices: yes,no
 ###########################################################################
 class CheckBox < DrgcmsField
   
@@ -563,7 +657,18 @@ end
 end
 
 ###########################################################################
-# Implementation of comment DRG CMS form field.
+# Implementation of comment DRG CMS form field. Comments may also be written
+# on the place of form field.
+# 
+# ===Form options:
+# * +text:+ any text. Text will be translated if key is found in translations. (required)
+# * +type:+ comment (required)
+#
+# Form example:
+#    30:
+#      name: active
+#      type: check_box
+
 ###########################################################################
 class Comment < DrgcmsField
   
@@ -571,14 +676,32 @@ class Comment < DrgcmsField
 # Render comment field html code
 ###########################################################################
 def render
-  @html << @yaml['text']
+  @html << t(@yaml['text'], @yaml['text'])
   self
 end
 end
 
 ###########################################################################
 # Implementation of link_to DRG CMS form field. link_to form field is mostly used by polls but can
-# be also incorporated in the middle of form.
+# be also incorporated anywhere on the form.
+# 
+# ===Form options:
+# * +type:+ link_to (required)
+# * +caption:+ Link caption 
+# * +icon:+ Link icon
+# * +url:+ direct url link
+# * +controller:+ controller name
+# * +action:+ action name 
+# * +html:+ html options which apply to link_to (optional)
+#      
+# Form example:
+#    30:
+#      type: link_to
+#      caption: Some action
+#      icon: cogs
+#      controller: my_controller
+#      action: my_action
+#      id: id # will be replaced by record._id
 ###########################################################################
 class LinkTo < DrgcmsField
   
@@ -590,13 +713,14 @@ def render
   @yaml['html']['class'] ||= 'dc-link dc-animate'
   @yaml['html'].symbolize_keys!
 #
+  @yaml[:id] = record._id if @yaml[:id] == 'id'
   url = @yaml['url'] || "#{@yaml[:controller]}/#{@yaml[:action]}/#{@yaml[:id]}"
   url.gsub!('//','/')                             # no action and id
   url = '/' + @yaml['url'] unless url[0,1] == '/' # no leading /
   url.chop if url[0,-1] == '/'                    # remove trailing /
 #
   caption = @yaml['caption'] || @yaml['text']
-  @html << @parent.link_to(caption, url, @yaml['html'])
+  @html << @parent.dc_link_to(caption, @yaml['icon'], url, @yaml['html'])
   self
 end
 end
@@ -604,6 +728,18 @@ end
 ###########################################################################
 # Create submit_tag form field. submit_tag form field is mostly used by polls but can
 # be also incorporated in the middle of form.
+# 
+# ===Form options:
+# * +type:+ submit_tag (required)
+# * +caption:+ Submit field caption 
+# * +icon:+ Icon
+# * +html:+ html options which apply to link_to (optional)
+#      
+# Form example:
+#    40:
+#      type: submit_tag
+#      caption: translate.this
+#      icon: check
 ###########################################################################
 class SubmitTag < DrgcmsField
   
@@ -624,11 +760,31 @@ end
 
 ###########################################################################
 # Implementation of password DRG CMS form field.
+# 
+# ===Form options:
+# * +type:+ password_field (required)
+# * +name:+ Field name (required) 
+# * +html:+ html options which apply to password field (optional)
+# 
+# Form example:
+#    20:
+#      name: password
+#      type: pasword_field
+#      html:
+#        size: 20
+#        
+#    30:
+#      name: password_confirmation
+#      type: pasword_field
+#      html:
+#        size: 20
+#        
 ###########################################################################
 class PasswordField < DrgcmsField
   
 ###########################################################################
 # Render password field html code
+# 
 ###########################################################################
 def render
   return self if @readonly
@@ -641,6 +797,21 @@ end
 
 ###########################################################################
 # Implementation of date_select DRG CMS form field.
+# 
+# ===Form options:
+# * +type:+ date_select (required)
+# * +name:+ Field name (required) 
+# * +options:+ options which apply to date_select field (optional)
+# * +html:+ html options which apply to password field (optional)
+# 
+# Form example:
+#    50:
+#      name: valid_from
+#      type: date_select
+#      options:
+#        include_blank: true
+#      html:
+#        class: my-date-class 
 ###########################################################################
 class DateSelect < DrgcmsField
    
@@ -648,9 +819,7 @@ class DateSelect < DrgcmsField
 # Render date_select field html code
 ###########################################################################
 def render
-#  return ro_standard if @readonly
   return ro_standard( @parent.dc_format_value(@record[@yaml['name']])) if @readonly
-  
 #
   @yaml['options'] ||= {}
   set_initial_value('options','default')
@@ -683,6 +852,19 @@ end
 
 ###########################################################################
 # Create datetime_select form field
+# 
+# ===Form options:
+# * +type:+ date_select (required)
+# * +name:+ Field name (required) 
+# * +options:+ options which apply to date_select field (optional)
+# * +html:+ html options which apply to password field (optional)
+# 
+# Form example:
+#    60:
+#      name: end_time
+#      type: date_time_select
+#      options:
+#        include_blank: true
 ###########################################################################
 class DatetimeSelect < DrgcmsField
   
@@ -712,7 +894,41 @@ end
 end
 
 ###########################################################################
-# Implementation of date_picker DRG CMS form field.
+# Implementation of date_picker DRG CMS form field with help of jQuery DateTimePicker plugin.
+# 
+# Since javascript date(time) format differs from ruby date(time) format localization
+# must be provided in order for date_picker object works as expected. For example:
+# 
+#   en:
+#    datetimepicker: 
+#     formats:
+#     date: 'Y/m/d'
+#     datetime: 'Y/m/d H:i'
+#
+#   sl:
+#    datetimepicker: 
+#     formats:
+#      date: 'd.m.Y'
+#      datetime: 'd.m.Y H:i'
+#
+# ===Form options:
+# * +type:+ date_picker (required)
+# * +name:+ Field name (required) 
+# * +options:+ options which apply to date_picker field. All options can be found here http://xdsoft.net/jqplugins/datetimepicker/ .
+# Options can be defined in single line like:
+# * options: 'inline: true,lang: "sl"' or
+# 
+# * options: 
+#   * inline: true
+#   * lang: '"sl"'
+#   
+# * +html:+ html options which apply to date_picker field (optional)
+# 
+# Form example:
+#    10:
+#      name: created
+#      type: date_picker
+#      options: 'inline: true,lang: "sl"'
 ###########################################################################
 class DatePicker < DrgcmsField
   
@@ -720,13 +936,13 @@ class DatePicker < DrgcmsField
 # Render date_picker field html code
 ###########################################################################
 def render
-#  return ro_standard if @readonly
-  return ro_standard( @parent.dc_format_value(@record[@yaml['name']])) if @readonly
+  value = @record[@yaml['name']] ? I18n.localize(@record[@yaml['name']].localtime.to_date) : nil
+  return ro_standard( @parent.dc_format_value(value)) if @readonly
 #
   @yaml['options'] ||= {}
   set_initial_value
   @yaml['html']['size'] ||= 10
-  @yaml['html']['value'] = I18n.localize(@record[@yaml['name']].localtime.to_date) if @record[@yaml['name']]
+  @yaml['html']['value'] = value
 #
   @yaml['options']['lang']   ||= "'#{I18n.locale}'"
   @yaml['options']['format'] ||= "'#{t('datetimepicker.formats.date')}'"
@@ -755,7 +971,27 @@ end
 
 end
 ###########################################################################
-# Implementation of date_time_picker DRG CMS form field.
+# Implementation of date_time_picker DRG CMS form field with help of jQuery DateTimePicker plugin
+# 
+# ===Form options:
+# * +type:+ date_time_picker (required)
+# * +name:+ Field name (required) 
+# * +options:+ options which apply to date_picker field. All options can be found here http://xdsoft.net/jqplugins/datetimepicker/ .
+# Options can be defined in single line like:
+# * options: 'step: 15,inline: true,lang: "sl"' or
+# 
+# * options: 
+#   * step: 15
+#   * inline: true
+#   * lang: '"sl"'
+#   
+# * +html:+ html options which apply to date_time_picker field (optional)
+# 
+# Form example:
+#    10:
+#      name: valid_to
+#      type: date_time_picker
+#      options: 'step: 60'
 ###########################################################################
 class DatetimePicker < DrgcmsField
   
@@ -763,13 +999,13 @@ class DatetimePicker < DrgcmsField
 # Render date_time_picker field html code
 ###########################################################################
 def render
-#  return ro_standard if @readonly
-  return ro_standard( @parent.dc_format_value(@record[@yaml['name']])) if @readonly
+  value = @record[@yaml['name']] ? I18n.localize(@record[@yaml['name']].localtime) : nil
+  return ro_standard( @parent.dc_format_value(value)) if @readonly
 #
   @yaml['options'] ||= {}
   set_initial_value
-  @yaml['html']['size'] ||= 12
-  @yaml['html']['value'] = I18n.localize(@record[@yaml['name']].localtime) if @record[@yaml['name']]
+  @yaml['html']['size'] ||= 14
+  @yaml['html']['value'] = value if @record[@yaml['name']]
 #
   @yaml['options']['lang']   ||= "'#{I18n.locale}'"
   @yaml['options']['format'] ||= "'#{t('datetimepicker.formats.datetime')}'"
@@ -799,9 +1035,27 @@ end
 
 ###########################################################################
 # Implementation of text_autocomplete DRG CMS form field.
+# 
+# ===Form options:
+# * +name:+ field name (required)
+# * +type:+ text_autocomplete (required)
+# * +table+ Collection (table) name. When defined search must contain field name
+# * +search:+ Search may consist of three parameters from which are separated either by dot (.) or comma(,)
+#   * search_field_name; when table option is defined search must define field name which will be used for search query
+#   * collection_name.search_field_name; Same as above except that table options must be ommited.
+#   * collection_name.search_field_name.method_name; When searching is more complex custom search
+#   method may be defined in CollectionName model which will provide result set for search.
+# 
+# Form example:
+#    10:
+#      name: user_id
+#      type: text_autocomplete
+#      search: dc_user.name
+#      html:
+#        size: 30
 ###########################################################################
 class TextAutocomplete < DrgcmsField
-  
+ 
 ###########################################################################
 # Render text_autocomplete field html code
 ###########################################################################
@@ -890,6 +1144,18 @@ end
 
 ###########################################################################
 # Implementation of text_area DRG CMS form field.
+# 
+# ===Form options:
+# * +type:+ text_area (required)
+# * +name:+ Field name (required) 
+# * +html:+ html options which apply to text_area field (optional)
+# 
+# Form example:
+#    10:
+#      name: css
+#      type: text_area
+#      html:
+#        size: 100x30
 ###########################################################################
 class TextArea < DrgcmsField
   
@@ -911,6 +1177,18 @@ end
 
 ###########################################################################
 # Implementation of text_field DRG CMS form field.
+# 
+# ===Form options:
+# * +type:+ text_field (required)
+# * +name:+ Field name (required) 
+# * +html:+ html options which apply to text_field field (optional)
+# 
+# Form example:
+#    10:
+#      name: title
+#      type: text_field
+#      html:
+#        size: 30
 ###########################################################################
 class TextField < DrgcmsField
   
@@ -928,9 +1206,39 @@ end
 end
 
 ###########################################################################
-# Implementation of text_with_select DRG CMS form field.
+# Implementation of text_with_select DRG CMS form field. Field will provide
+# text_field entry field with select dropdown box with optional values for the field.
+# Form options are mostly same as in select field. 
+# 
+# ===Form options:
+# * +name:+ field name (required)
+# * +type:+ text_with_select (required)
+# * +choices:+ Values for choices separated by comma. Values can also be specified like description:value.
+# In this case description will be shown to user, but value will be saved to document.
+#   * choices: 'OK:0,Ready:1,Error:2'
+#   * choices: Ruby,Pyton,PHP
+# * +eval:+ Choices will be provided by evaluating expression
+#   * eval: dc_choices4('model_name','description_field_name','_id'); dc_choices4 helper will provide data for select field. 
+#   * eval: ModelName.choices4_field; ModelName class will define method choices4_field which 
+#   will provide data for select field. Since expression is evaluated in the context of Form Field object
+#   even session session variables can be accessed. Ex. +eval: 'MyClass.method(@parent.session[:user_id])'+
+#   * collection_name.search_field_name.method_name; When searching is more complex custom search
+#   method may be defined in CollectionName model which will provide result set for search.
+# * If choices or eval is not defined choices will be provided from translation helpers. For example: 
+#   Collection has field status choices for field may be provided by en.helpers.model_name.choices4_status 
+#   entry of english translation. English is of course default translation. If you provide translations in
+#   your local language then select choices will be localized.
+#   * en.helpers.model_name.choices4_status: 'OK:0,Ready:1,Error:2'
+#   * sl.helpers.model_name.choices4_status: 'V redu:0,Pripravljen:1,Napaka:2'
+# * +html:+ html options which apply to select and text_field fields (optional)
 # 
-# Create text_field with select dropdown box with optional values for the field
+# Form example:
+#    10:
+#      name: link
+#      type: text_with_select
+#      eval: '@parent.dc_page_class.all_pages_for_site(@parent.dc_get_site)'
+#      html:
+#        size: 50
 ###########################################################################
 class TextWithSelect < Select
 
@@ -963,11 +1271,25 @@ end
 end
 
 ###########################################################################
-# Implementation of html_field DRG CMS form field.
+# Implementation of html_field DRG CMS form field. 
+# 
+# HtmlField class only implements code for calling actual html edit field code.
+# This is by default drg_default_html_editor gem which uses CK editor javascript plugin 
+# or any other plugin. Which plugin will be used as html editor is defined by 
+# dc_site.settings html_editor setting. 
 # 
-# HtmlField class implements redirection for calling actual html edit field code.
-# This can be drg_default_html_editor's ckeditor or any other code defined
-# by dc_site.settings html_editor setting.
+# Example of dc_site.setting used for drg_default_html_editor gem.
+#    html_editor: ckeditor
+#    ck_editor:
+#      config_file: /files/ck_config.js  
+#      css_file: /files/ck_css.css
+#   file_select: elfinder
+#   
+# Form example:
+#    10:
+#      name: body
+#      type: html_field
+#      options: "height: 500, width: 550, toolbar: 'basic'" 
 ###########################################################################
 class HtmlField < DrgcmsField
 
@@ -999,6 +1321,20 @@ end
 # FileSelect like HtmlField implements redirection for calling document manager edit field code.
 # This can be drg_default_html_editor's elfinder or any other code defined
 # by dc_site.settings file_select setting.
+# 
+# Example of dc_site.setting used for drg_default_html_editor gem.
+#    html_editor: ckeditor
+#    ck_editor:
+#      config_file: /files/ck_config.js  
+#      css_file: /files/ck_css.css
+#   file_select: elfinder
+#   
+# Form example:
+#    60:
+#      name: picture
+#      type: file_select
+#      html:
+#        size: 50   
 ###########################################################################
 class FileSelect < DrgcmsField