Added hints to description fields to use markdown syntax, rendered all description fields in the splash as markdown

2026-08-17 13:44:09 +00:00 · 2014-06-29 17:44:27 +05:30 · 2014-06-29 17:44:27 +05:30 · 8efcd69f3d
commit 8efcd69f3d
parent f6a9142510
15 changed files with 30 additions and 24 deletions
--- a/app/helpers/application_helper.rb
+++ b/app/helpers/application_helper.rb
@ -198,13 +198,17 @@ module ApplicationHelper
    default_brand
  end

-  def dat_markdown(text)
+  def markdown(text)
    options = {
-      :autolink => true,
-      :space_after_headers => true,
-      :no_intra_emphasis => true
+      autolink: true,
+      space_after_headers: true,
+      no_intra_emphasis: true
    }
    markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, options)
    markdown.render(text).html_safe
  end
+
+  def markdown_hint(text="")
+    markdown("#{text} Please look at #{link_to '**Markdown Syntax**', 'https://daringfireball.net/projects/markdown/syntax', target: '_blank'} to format your text")
+  end
 end
--- a/app/views/admin/callforpapers/show.html.haml
+++ b/app/views/admin/callforpapers/show.html.haml
@ -4,7 +4,7 @@
      = f.input :include_cfp_in_splash, label: 'Include Call for Papers in Splash', hint: 'On setting this true you will enable the call for papers to be displayed on the splash page'
      = f.input :start_date, :as => :string, :input_html => { :id => "conference-start-datepicker", :readonly => "readonly"  }
      = f.input :end_date, :as => :string, :input_html => { :id => "conference-end-datepicker", :readonly => "readonly"  }
-      = f.input :description, :hint => "Welcome text for the Call for Papers"
+      = f.input :description, hint: markdown_hint("Welcome text for the Call for Papers."), input_html: { data: { provide: "markdown-editable" } }
      = f.input :schedule_changes
      = f.input :schedule_public
      = f.input :rating, :hint => "Enter the number of different rating levels you want to have for voting on proposals. Enter 0 if you do not want to vote on proposals."
--- a/app/views/admin/conference/edit.html.haml
+++ b/app/views/admin/conference/edit.html.haml
@ -12,7 +12,7 @@
      = f.inputs name: 'Banner for Splash' do
        = f.input :include_banner_in_splash, hint: 'This enable the Banner Photo with description to be displayed on the splash'
        = f.input :banner_photo, hint: 'This will be the top most component of the splash.This background cover will contain start_date and end_date of the conference and the description'
-        = f.input :description, hint: 'This description will be shown at the bottom of the banner photo of the Splash'
+        = f.input :description, hint: markdown_hint("This description will be shown at the bottom of the banner photo of the Splash."), input_html: { data: { provide: "markdown-editable" } }

      = f.inputs :name => "Scheduling" do
        = f.input :timezone, :as => :time_zone, :hint => "The conference time zone"
@ -22,11 +22,11 @@
        = f.input :include_registrations_in_splash, hint: 'On setting this true you will enable the registrations to be displayed on the splash page'
        = f.input :registration_start_date, :as => :string, :input_html => { :id => "conference-reg-start-datepicker", :readonly => "readonly"  }
        = f.input :registration_end_date, :as => :string, :input_html => { :id => "conference-reg-end-datepicker", :readonly => "readonly"  }
-        = f.input :registration_description, hint: 'This description will appear in registration segment of the splash'
-      = f.input :ticket_description, hint: 'This will appear in the Tickets segment of the splash'
-      = f.input :sponsor_description, hint: 'This will appear in the sponsor segment of the splash'
+        = f.input :registration_description, hint: markdown_hint("This description will appear in registration segment of the splash."), input_html: { data: { provide: "markdown-editable" } }
+      = f.input :ticket_description, hint: markdown_hint("This will appear in the Tickets segment of the splash."), input_html: { data: { provide: "markdown-editable" } }
+      = f.input :sponsor_description, hint: markdown_hint("This will appear in the sponsor segment of the splash."), input_html: { data: { provide: "markdown-editable" } }
      = f.input :sponsor_email, hint: 'This will appear in the sponsor segment of the splash for the sponsors to contact to the organizers'
-      = f.input :lodging_description, hint: 'This will appear in the lodging segment of the splash'
+      = f.input :lodging_description, hint: markdown_hint("This will appear in the lodging segment of the splash."), input_html: { data: { provide: "markdown-editable" } }

      = dynamic_association :photos, "Photos", f

--- a/app/views/admin/lodgings/_lodging_fields.html.erb
+++ b/app/views/admin/lodgings/_lodging_fields.html.erb
@ -1,8 +1,7 @@
 <div class="nested-fields">
    <%= f.inputs do %>
      <%= f.input :name %>
-      <%= f.input :description, :input_html => {:rows => 2 }, hint: 'Write about the hotel/place,
-       of what they are offering, about types of rooms, prices and address' %>
+      <%= f.input :description, :input_html => {:rows => 2, data: { provide: "markdown-editable" } }, hint: markdown_hint("Write about the hotel/place, of what they are offering, about types of rooms, prices and address.") %>
      <%= image_tag f.object.photo(:thumb) if !f.object.photo.blank? %>
      <%= f.input :photo %>
      <%= f.input :website_link %>
--- a/app/views/admin/supporter_levels/_supporter_level_fields.html.erb
+++ b/app/views/admin/supporter_levels/_supporter_level_fields.html.erb
@ -2,7 +2,7 @@
    <%= f.inputs do %>
        <%= f.input :title%>
        <%= f.input :url  %>
-        <%= f.input :description %>
+        <%= f.input :description, hint: markdown_hint, input_html: { data: { provide: "markdown-editable" } } %>
        <%= f.input :ticket_price, hint: 'Please enter price with currency symbol.
                                          For example, $200,₹300' %>
        <%= remove_association_link :supporter_level, f %>
--- a/app/views/admin/tracks/_track_fields.html.erb
+++ b/app/views/admin/tracks/_track_fields.html.erb
@ -2,7 +2,7 @@
    <%= f.inputs do %>
        <%= f.input :name %>
        <%= f.input :color, :input_html => {:size => 6, :type => "color"}, :required=> true %>
-        <%= f.input :description, :input_html => {:rows => 2 } %>
+        <%= f.input :description, :input_html => {:rows => 2, data: { provide: "markdown-editable" } }, hint: markdown_hint %>
        <%= remove_association_link :track, f %>
    <% end %>
 </div>
--- a/app/views/admin/venue/venue_info.html.haml
+++ b/app/views/admin/venue/venue_info.html.haml
@ -5,7 +5,7 @@
      = f.input :name, :input_html => {:rows => 1}
      = f.input :address, :input_html => {:rows => 1}
      = f.input :website
-      = f.input :description, :input_html => { :rows => 10, :cols => 20 }
+      = f.input :description, :input_html => { :rows => 10, :cols => 20, data: { provide: "markdown-editable" } }, hint: markdown_hint
      - unless @venue.photo.blank?
        = image_tag @venue.photo(:thumb)
      = f.input :photo
--- a/app/views/conference/_call_for_papers.html.haml
+++ b/app/views/conference/_call_for_papers.html.haml
@ -9,7 +9,7 @@
        Call For Papers
      - if !@conference.call_for_papers.description.blank?
        %p
-          = @conference.call_for_papers.description
+          = markdown(@conference.call_for_papers.description)
      - if !@conference.call_for_papers.start_date.blank? && !@conference.call_for_papers.end_date.blank?
        %p.lead Proposals will be accepted between
        #cfp-date
--- a/app/views/conference/_location.html.haml
+++ b/app/views/conference/_location.html.haml
@ -14,7 +14,7 @@
          %strong #{ @conference.venue.address }
      - unless @conference.venue.description.blank?
        %p
-          = @conference.venue.description
+          = markdown(@conference.venue.description)
      %ul.location-links
        - unless @conference.venue.address.blank?
          %li
--- a/app/views/conference/_lodging.html.haml
+++ b/app/views/conference/_lodging.html.haml
@ -2,7 +2,7 @@
  %h2 Lodgings
  -unless @conference.lodging_description.blank?
    %p.lead
-      = @conference.lodging_description
+      = markdown(@conference.lodging_description)

  %div.row.text-center
    - @conference.venue.lodgings.each do |r|
@ -13,7 +13,7 @@
          -unless r.name.blank?
            %h4.text-center #{ r.name }
          -unless r.description.blank?
-            %p.text-left #{ r.description }
+            %p.text-left #{ markdown(r.description) }
          - unless r.website_link.blank?
            .text-center
              = link_to 'Go to Website', r.website_link
--- a/app/views/conference/_registration.html.haml
+++ b/app/views/conference/_registration.html.haml
@ -6,7 +6,7 @@
    %h1 Registration
  - if !@conference.registration_description.blank?
    %p
-      = @conference.registration_description
+      = markdown(@conference.registration_description)
  - if @conference.registration_dates_given?
    -if @conference.registration_end_date >= Date.today
      %h4 Registration period #{ date_string(@conference.registration_start_date, @conference.registration_end_date) }
--- a/app/views/conference/_sponsor.html.haml
+++ b/app/views/conference/_sponsor.html.haml
@ -6,7 +6,8 @@
    %div.col-md-12
      %h2 Sponsors
      -if !@conference.sponsor_description.blank?
-        %p #{ @conference.sponsor_description }
+        %p
+        = markdown(@conference.sponsor_description)
      -if !@conference.sponsor_email.blank?
        %h3= mail_to "#{ @conference.sponsor_email }", 'Become a Sponsor'
  - if !@conference.sponsorship_levels.blank?
--- a/app/views/conference/_tickets.html.haml
+++ b/app/views/conference/_tickets.html.haml
@ -1,7 +1,8 @@
 %div.row
  %h3 Tickets
  -if !@conference.ticket_description.blank?
-    %p #{ @conference.ticket_description }
+    %p
+      = markdown(@conference.ticket_description)
    - @conference.supporter_levels.each do |s|
      %div.col-md-6
        - if !s.title.blank?
--- a/app/views/conference/_tracks.html.haml
+++ b/app/views/conference/_tracks.html.haml
@ -6,4 +6,4 @@
        %h4
          = t.name
        %p
-          = t.description
+          = markdown(t.description)
--- a/app/views/conference/show.html.haml
+++ b/app/views/conference/show.html.haml
@ -16,7 +16,8 @@
          - unless @conference.description.blank?
            .row-fluid
              .col-md-12.lead
-                %p= @conference.description
+                %p
+                  = markdown(@conference.description)
          -unless @conference.photos.blank?
            = link_to 'Gallery', gallery_photos_conference_path(@conference.short_title), class: 'btn btn-primary btn-lg', id: 'gallery-btn', remote: true
            = render 'gallery'