db/migrate/002_add_pdf_title.rb @@ -1,21 +1,18 @@ -== ezFAQ plugin 0.1.0 +== ezFAQ plugin 0.1.9 This is a FAQ management plugin for Redmine == Upgrade Note -1. WARNING: ezFAQ 0.0.4 ONLY compitable with redmine after devel.r2429. - It's not compitable with stable versions(0.8.0 or 0.7.4)(for redmine has changed - it's attachment mechanism after 0.8.0) +1. WARNING: ezFAQ 0.1.x ONLY compitable with redmine after devel.r2429. If you use redmine 0.8.0, please use ezfaq 0.0.2 at redmine's plugin wiki page. -== Installation +2. 0.1.9 has mailer errors!!! -=== Adding plugin support to Redmine +== Installation To add plugin support to Redmine, install engines plugin: - See: http://rails-engines.org/ - Also: http://www.redmine.org/wiki/redmine/Plugins + See: http://www.redmine.org/wiki/redmine/Plugins === Plugin installation @@ -30,6 +27,9 @@ Installed plugins are listed on 'Admin -> Plugins' screen. === Changelog +0.1.9 -> Add export to PDF function to FAQ and FAQ-list. + This version has a mailer error, the mail function is disabled and will be corrected in 0.2.0. + 0.1.0 -> Compitable with redmine devel after r2493 and rails 2.2.2 Add cs.yml language. @@ -43,7 +43,6 @@ Installed plugins are listed on 'Admin -> Plugins' screen. attatchment manage mechanism. Change permission and menu into gloc strings and now they can be localized. - === Feature 1. Ask question and request a user to answer it. @@ -51,6 +50,7 @@ Installed plugins are listed on 'Admin -> Plugins' screen. 3. FAQ's modification has history logs. 4. Send notify email to the author and the assigned user who should answer the question. 5. FAQ creation or edit is added to redmine's activity. +6. FAQ and FAQ-list can be exported to PDF document. === Credits @@ -62,12 +62,6 @@ Thanks for edavis10 at http://github.com/edavis10/ for his redmine core patch. cs.yml - Marek Hulán de.yml - Mathias Kühn -=== Roadmap - -0.2.0 -> Generate pdf version FAQ document including all valid FAQ. - (note: maybe delayed, if you need this feature, please let know) - - === Contact info Homepage -> http://218.107.133.32:5000/projects/show/ezwork powered by redmine README @@ -28,11 +28,17 @@ class EzfaqController < ApplicationController include MessagesHelper helper :sort include SortHelper + include Redmine::Export::PDF def index @categorized_faqs = Faq.find(:all, :conditions => "project_id = #{@project.id} and category_id is not null and is_valid = true") @not_categorized_faqs = Faq.find(:all, :conditions => "project_id = #{@project.id} and category_id is null and is_valid = true", :order => "question") @faq_setting = FaqSetting.find(:first, :conditions => "project_id = #{@project.id}") + + respond_to do |format| + format.html { render :template => 'ezfaq/index.html.erb', :layout => !request.xhr? } + format.pdf { send_data(faqs_to_pdf, :type => 'application/pdf', :filename => "#{@project}-faq.pdf") } + end end def list_invalid_faqs @@ -46,8 +52,12 @@ class EzfaqController < ApplicationController def show @faq.viewed_count += 1 Faq.update_all("viewed_count = #{@faq.viewed_count}", "id = #{@faq.id}") - @faq_categories = FaqCategory.find(:all, :conditions => "project_id = #{@project.id}", :order => "position") + + respond_to do |format| + format.html { render :template => 'ezfaq/show.html.erb', :layout => !request.xhr? } + format.pdf { send_data(faq_to_pdf, :type => 'application/pdf', :filename => "#{@project}-faq-#{@faq.id}.pdf") } + end end def new @@ -66,7 +76,7 @@ class EzfaqController < ApplicationController if @faq.save attach_files(@faq, params[:attachments]) flash[:notice] = l(:notice_successful_create) - FaqMailer.deliver_faq_add(@project, @faq) + #FaqMailer.deliver_faq_add(@project, @faq) redirect_to :controller => 'ezfaq', :action => 'show', :id => @project, :faq_id => @faq return end @@ -88,7 +98,7 @@ class EzfaqController < ApplicationController if @faq.save attach_files(@faq, params[:attachments]) flash[:notice] = l(:notice_successful_update) - FaqMailer.deliver_faq_update(@project, @faq) + #FaqMailer.deliver_faq_update(@project, @faq) redirect_to :controller => 'ezfaq', :action => 'show', :id => @project, :faq_id => @faq return end @@ -188,5 +198,95 @@ private rescue ActiveRecord::RecordNotFound render_404 end - + + def faq_to_pdf + faq_setting = FaqSetting.find(:first, :conditions => "project_id = #{@project.id}") + + pdf = IFPDF.new(current_language) + pdf.SetTitle("FAQ-#{@faq.question}") + pdf.SetAuthor('ezFAQ for Redmine') + pdf.AliasNbPages + pdf.footer_date = format_date(Date.today) + pdf.AddPage + + pdf.SetFontStyle('B',16) + pdf.Cell(200,5, faq_setting.pdf_title) + pdf.Ln(15) + + pdf.SetFontStyle('B',11) + pdf.Cell(200,5, "#{l(:field_question)}: #{@faq.question}") + pdf.Ln + pdf.Line(pdf.GetX, pdf.GetY, 180, pdf.GetY) + pdf.Ln + pdf.SetFontStyle('',11) + pdf.MultiCell(200,5, @faq.answer) + pdf.Ln + + pdf.Line(pdf.GetX, pdf.GetY, 100, pdf.GetY) + pdf.SetFontStyle('I',8) + pdf.Cell(200,5, 'Auto generated faq-document by ezFAQ. Powered by ezWORK & Redmine.') + + pdf.Output + end + + def faqs_to_pdf + pdf = IFPDF.new(current_language) + pdf.SetTitle(@faq_setting.pdf_title) + pdf.SetAuthor('ezFAQ for Redmine') + pdf.AliasNbPages + pdf.footer_date = format_date(Date.today) + pdf.AddPage + + pdf.SetFontStyle('B',16) + pdf.Cell(200,5, @faq_setting.pdf_title) + pdf.Ln(10) + pdf.SetFontStyle('',11) + pdf.MultiCell(180,5, @faq_setting.note) + pdf.Ln + pdf.Line(pdf.GetX, pdf.GetY, 180, pdf.GetY) + pdf.Ln + + list_number = 1 + if @categorized_faqs.any? + @categorized_faqs.group_by(&:category).sort.each do |category, faqs| + pdf.SetFontStyle('BI', 13) + pdf.Cell(200,5, "#{list_number}. #{category.name}") + pdf.Ln + faq_number = 1 + for faq in faqs.sort + pdf.SetFontStyle('B',11) + pdf.Cell(200,5, "#{list_number}.#{faq_number} #{faq.question}") + pdf.Ln + pdf.SetFontStyle('',11) + pdf.MultiCell(200,5, faq.answer) + pdf.Ln + faq_number += 1 + end + pdf.Ln + list_number += 1 + end + end + + if @not_categorized_faqs.any? + pdf.SetFontStyle('BI', 13) + pdf.Cell(200,5, "#{list_number}. #{l(:label_not_categorized)}") + pdf.Ln + faq_number = 1 + for faq in @not_categorized_faqs.sort + pdf.SetFontStyle('B',11) + pdf.Cell(200,5, "#{list_number}.#{faq_number} #{faq.question}") + pdf.Ln + pdf.SetFontStyle('',11) + pdf.MultiCell(200,5, faq.answer) + pdf.Ln(10) + faq_number += 1 + end + end + + pdf.Line(pdf.GetX, pdf.GetY, 100, pdf.GetY) + pdf.SetFontStyle('I',8) + pdf.Cell(200,5, 'Auto generated faq-list by ezFAQ. Powered by ezWORK & Redmine.') + + pdf.Output + end end app/controllers/ezfaq_controller.rb @@ -1,5 +1,4 @@ class FaqSetting < ActiveRecord::Base - - - + validates_presence_of :pdf_title, :note + validates_length_of :pdf_title, :maximum => 200 end app/models/faq_setting.rb @@ -1,10 +1,11 @@ <h2><%= l(:label_settings) %></h2> <div id="settings"> -<% form_for :faq_setting do |f| %> -<div class="box tabular"> - <p><label><%=l(:label_faq_note)%></label> - <%= f.text_area :note, :cols => 60, :rows => 4 %></p> +<% labelled_tabular_form_for :faq_setting, @faq_setting, :url => {:id => @project}, :html => {:id => 'faq_setting-form'} do |f| %> +<%= error_messages_for 'faq_setting' %> +<div class="box"> + <p><%= f.text_field :pdf_title, :size =>80, :required => true %></p> + <p><%= f.text_area :note, :label => :field_faq_note,:cols => 80, :rows => 4, :required => true %></p> </div> <%= submit_tag l(:button_save) %> <% end %> app/views/ezfaq/faq_setting.html.erb @@ -24,6 +24,10 @@ <p class="nodata"><%= l(:label_no_data) %></p> <% end %> +<% other_formats_links do |f| %> + <%= f.link_to 'PDF' %> +<% end %> + <% content_for :sidebar do %> <%= render :partial => 'ezfaq/sidebar' %> <% end %> app/views/ezfaq/index.html.erb @@ -53,6 +53,10 @@ </div> +<% other_formats_links do |f| %> + <%= f.link_to 'PDF', :url => {:faq_id => @faq} %> +<% end %> + <% content_for :sidebar do %> <%= render :partial => 'ezfaq/sidebar' %> <% end %> app/views/ezfaq/show.html.erb @@ -16,7 +16,6 @@ cs: label_info_for_input_id: (Prosím vyplňte id) label_manage: Spravovat label_faq_setting: Nastavení FAQ - label_faq_note: FAQ poznámka(Zobrazeno před seznamem FAQ) label_updated_time_by: Upraveno uživatelem {{author}} před {{age}} field_question: Otázka @@ -28,6 +27,8 @@ cs: field_related_message: Související zpráva field_is_valid: Validní field_faq_counts_under_category: Počet FAQ + field_pdf_title: Title of PDF document + field_faq_note: FAQ poznámka(Zobrazeno před seznamem FAQ) text_faq_category_destroy_question: Nějaké FAQ ({{value}}) je již přiřazeno do této kategorie. Co chcete udělat? text_faq_category_destroy_assignments: Odstranit přiřazení kategorie config/locales/cs.yml @@ -16,7 +16,6 @@ de: label_info_for_input_id: (Bitte id eingeben) label_manage: Verwalten label_faq_setting: FAQ Einstellungen - label_faq_note: FAQ note(Displayed before the FAQ list) label_updated_time_by: Updated by {{author}} {{age}} ago field_question: Frage @@ -28,7 +27,9 @@ de: field_related_message: Verwandte Nachricht field_is_valid: Gültig field_faq_counts_under_category: FAQ Anzahl - + field_pdf_title: Title of PDF document + field_faq_note: FAQ note(Displayed before the FAQ list) + text_faq_category_destroy_question: Manche FAQs ({{value}}) sind dieser Kategorie zugeordnet. Was möchten Sie tun? text_faq_category_destroy_assignments: Entferne die Zuordnungen text_faq_category_reassign_to: FAQ wieder dieser Kategorie zuordnen config/locales/de.yml @@ -16,7 +16,6 @@ en: label_info_for_input_id: (Please input id) label_manage: Manage label_faq_setting: FAQ setting - label_faq_note: FAQ note(Displayed before the FAQ list) label_updated_time_by: Updated by {{author}} {{age}} ago field_question: Question @@ -28,6 +27,8 @@ en: field_related_message: Related Message field_is_valid: Valid field_faq_counts_under_category: FAQ count + field_pdf_title: Title of PDF document + field_faq_note: FAQ note(Displayed before the FAQ list) text_faq_category_destroy_question: Some FAQ ({{value}}) is assigned to this category. What do you want to do ? text_faq_category_destroy_assignments: Remove category assignments config/locales/en.yml @@ -16,7 +16,6 @@ zh: label_info_for_input_id: (请输入编号) label_manage: 管理 label_faq_setting: FAQ配置 - label_faq_note: FAQ说明(显示在FAQ列表前) label_updated_time_by: 由 {{author}} 在 {{age}} 之前更新 field_question: 问题 @@ -28,6 +27,8 @@ zh: field_related_message: 相关讨论区帖子 field_is_valid: 是否有效 field_faq_counts_under_category: FAQ数量 + field_pdf_title: PDF文档的标题 + field_faq_note: FAQ说明(显示在FAQ列表前) text_faq_category_destroy_question: 有一些FAQ（{{value}} 个）属于此类别。您想进行哪种操作？ text_faq_category_destroy_assignments: 删除FAQ的所属类别（FAQ变为无类别） config/locales/zh.yml @@ -26,7 +26,7 @@ Redmine::Plugin.register :ezfaq_plugin do name 'ezFAQ plugin' author 'Zou Chaoqun' description 'This is a FAQ management plugin for Redmine' - version '0.1.0' + version '0.1.9' project_module :ezfaq do permission :view_faqs, {:ezfaq => [:index, :show, :history, :diff, :show_history_version]}, :public => true init.rb 81bc65ec62fffcbabb9d24958bd875e04ea06b52 zouchaoqun zouchaoqun@gmail.com http://github.com/zouchaoqun/ezfaq/commit/a08d476dd98f4599e6b76e265f69a419d164ade0 a08d476dd98f4599e6b76e265f69a419d164ade0 2009-02-28T22:11:12-08:00 2009-02-28T22:11:12-08:00 add export to pdf function;still waiting for mailer correction a49fc451ab70e0feb989307d3365df36f48cae7f zouchaoqun zouchaoqun@gmail.com