Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

chore(refactoring): move shared and entity-specific code out of models/work_package/pdf_export/

as-op7166a79d7746
diff --git a/app/models/work_package/pdf_export/common/attachments.rb b/app/models/exports/pdf/common/attachments.rb
similarity index 98%
rename from app/models/work_package/pdf_export/common/attachments.rb
rename to app/models/exports/pdf/common/attachments.rb
index 056c50c5c17..ccf3cef3dae 100644
--- a/app/models/work_package/pdf_export/common/attachments.rb
+++ b/app/models/exports/pdf/common/attachments.rb
@@ -28,7 +28,7 @@
require "mini_magick"
-module WorkPackage::PDFExport::Common::Attachments
+module Exports::PDF::Common::Attachments
def resize_image(file_path)
tmp_file = temp_image_file(File.extname(file_path))
diff --git a/app/models/work_package/pdf_export/common/badge.rb b/app/models/exports/pdf/common/badge.rb
similarity index 98%
rename from app/models/work_package/pdf_export/common/badge.rb
rename to app/models/exports/pdf/common/badge.rb
index 98bee7fc8a5..9933831086b 100644
--- a/app/models/work_package/pdf_export/common/badge.rb
+++ b/app/models/exports/pdf/common/badge.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Common::Badge
+module Exports::PDF::Common::Badge
class BadgeCallback
def initialize(options)
@color = options[:color]
diff --git a/app/models/work_package/pdf_export/common/common.rb b/app/models/exports/pdf/common/common.rb
similarity index 90%
rename from app/models/work_package/pdf_export/common/common.rb
rename to app/models/exports/pdf/common/common.rb
index f63277488c6..e0e9f6c0a43 100644
--- a/app/models/work_package/pdf_export/common/common.rb
+++ b/app/models/exports/pdf/common/common.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Common::Common
+module Exports::PDF::Common::Common
include Redmine::I18n
include ActionView::Helpers::TextHelper
include ActionView::Helpers::NumberHelper
@@ -38,7 +38,7 @@ module WorkPackage::PDFExport::Common::Common
private
def get_pdf
- ::WorkPackage::PDFExport::Common::View.new(current_language)
+ ::Exports::PDF::Common::View.new(current_language)
end
def field_value(work_package, attribute)
@@ -101,24 +101,20 @@ module WorkPackage::PDFExport::Common::Common
pdf.table(data, options.merge({ width: pdf.bounds.width }), &)
rescue Prawn::Errors::CannotFit
- pdf.table(data, options.merge({ column_widths: }), &)
+ pdf_table_fixed_widths(data, column_widths, options, &)
end
- def draw_text_multiline_left(text:, text_style:, max_left:, top:, max_lines:)
- lines = wrap_to_lines(text, max_left - pdf.bounds.left, text_style, max_lines)
- starting_position = top
- lines.reverse_each do |line|
- starting_position += draw_text_multiline_part(line, text_style, pdf.bounds.left, starting_position)
- end
+ def pdf_table_fixed_widths(data, column_widths, options, &)
+ pdf.table(data, options.merge({ column_widths: }), &) unless data.empty?
end
- def draw_text_multiline_right(text:, text_style:, max_left:, top:, max_lines:)
- lines = wrap_to_lines(text, pdf.bounds.right - max_left, text_style, max_lines)
+ def draw_text_multiline_center(text:, text_style:, left:, available_width:, top:, max_lines:)
+ lines = wrap_to_lines(text, available_width, text_style, max_lines)
starting_position = top
lines.reverse_each do |line|
line_width = measure_text_width(line, text_style)
- line_x = pdf.bounds.right - line_width
- starting_position += draw_text_multiline_part(line, text_style, line_x, starting_position)
+ line_x = (available_width - line_width) / 2
+ starting_position += draw_text_multiline_part(line, text_style, left + line_x, starting_position)
end
end
@@ -157,6 +153,18 @@ module WorkPackage::PDFExport::Common::Common
[text_x, text_width]
end
+ def draw_text_left(text, text_style, top)
+ text_width = measure_text_width(text, text_style)
+ draw_styled_text text, text_style.merge({ at: [0, top] })
+ text_width
+ end
+
+ def draw_text_right(text, text_style, top)
+ text_width = measure_text_width(text, text_style)
+ draw_styled_text text, text_style.merge({ at: [pdf.bounds.width - text_width, top] })
+ text_width
+ end
+
def draw_text_multiline_part(line, text_style, x_position, y_position)
draw_styled_text line, text_style.merge({ at: [x_position, y_position] })
measure_text_height(line, text_style)
@@ -248,17 +256,21 @@ module WorkPackage::PDFExport::Common::Common
end
def get_column_value(work_package, column_name)
- formatter = formatter_for(column_name, :pdf)
+ formatter = wp_formatter_for(column_name, :pdf)
formatter.format(work_package)
end
def get_formatted_value(value, column_name)
return "" if value.nil?
- formatter = formatter_for(column_name, :pdf)
+ formatter = wp_formatter_for(column_name, :pdf)
formatter.format_value(value, {})
end
+ def wp_formatter_for(column_name, format)
+ ::Exports::Register.formatter_for(WorkPackage, column_name, format)
+ end
+
def hyphenation_enabled
ActiveModel::Type::Boolean.new.cast(options[:hyphenation])
end
diff --git a/app/models/work_package/pdf_export/common/logo.rb b/app/models/exports/pdf/common/logo.rb
similarity index 97%
rename from app/models/work_package/pdf_export/common/logo.rb
rename to app/models/exports/pdf/common/logo.rb
index fe4cc81b6f2..3bdde54fb6e 100644
--- a/app/models/work_package/pdf_export/common/logo.rb
+++ b/app/models/exports/pdf/common/logo.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Common::Logo
+module Exports::PDF::Common::Logo
def logo_image
image_obj, image_info = pdf.build_image_object(logo_image_filename)
[image_obj, image_info]
diff --git a/app/models/work_package/pdf_export/common/macro.rb b/app/models/exports/pdf/common/macro.rb
similarity index 98%
rename from app/models/work_package/pdf_export/common/macro.rb
rename to app/models/exports/pdf/common/macro.rb
index 26895f07f75..8002bef6b11 100644
--- a/app/models/work_package/pdf_export/common/macro.rb
+++ b/app/models/exports/pdf/common/macro.rb
@@ -26,7 +26,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Common::Macro
+module Exports::PDF::Common::Macro
PREFORMATTED_BLOCKS = %w(pre code).freeze
def apply_markdown_field_macros(markdown, context)
diff --git a/app/models/work_package/pdf_export/export/markdown.rb b/app/models/exports/pdf/common/markdown.rb
similarity index 98%
rename from app/models/work_package/pdf_export/export/markdown.rb
rename to app/models/exports/pdf/common/markdown.rb
index 94ce3064b0f..169fdc0005f 100644
--- a/app/models/work_package/pdf_export/export/markdown.rb
+++ b/app/models/exports/pdf/common/markdown.rb
@@ -30,11 +30,11 @@
require "md_to_pdf/core"
-module WorkPackage::PDFExport::Export::Markdown
+module Exports::PDF::Common::Markdown
class MD2PDFExport
include MarkdownToPDF::Core
include MarkdownToPDF::Parser
- include WorkPackage::PDFExport::Common::Common
+ include Exports::PDF::Common::Common
def initialize(styling_yml, pdf, hyphenation_language)
@styles = MarkdownToPDF::Styles.new(styling_yml)
diff --git a/app/models/work_package/pdf_export/common/styles.rb b/app/models/exports/pdf/common/styles.rb
similarity index 98%
rename from app/models/work_package/pdf_export/common/styles.rb
rename to app/models/exports/pdf/common/styles.rb
index d62a564146b..676c2169221 100644
--- a/app/models/work_package/pdf_export/common/styles.rb
+++ b/app/models/exports/pdf/common/styles.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Common::Styles
+module Exports::PDF::Common::Styles
include MarkdownToPDF::StyleValidation
def initialize(styles_asset_path, style_yml_file = "standard.yml", schema_json_file = "schema.json")
diff --git a/app/models/work_package/pdf_export/common/view.rb b/app/models/exports/pdf/common/view.rb
similarity index 96%
rename from app/models/work_package/pdf_export/common/view.rb
rename to app/models/exports/pdf/common/view.rb
index 3dc91ce6211..e37fa6e6c30 100644
--- a/app/models/work_package/pdf_export/common/view.rb
+++ b/app/models/exports/pdf/common/view.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-class WorkPackage::PDFExport::Common::View
+class Exports::PDF::Common::View
include Prawn::View
include Redmine::I18n
@@ -53,6 +53,10 @@ class WorkPackage::PDFExport::Common::View
set_language_if_valid lang
end
+ def self.default_font
+ FONT_SPEC[:latin].first[:name]
+ end
+
def options
@options ||= {}
end
@@ -68,7 +72,7 @@ class WorkPackage::PDFExport::Common::View
@document ||= Prawn::Document.new(options.merge(info:)).tap do |document|
register_fonts! document
- document.set_font document.font("NotoSans")
+ document.set_font document.font(Exports::PDF::Common::View::default_font)
document.fallback_fonts = fallback_fonts
end
end
diff --git a/app/models/work_package/pdf_export/export/cover.rb b/app/models/exports/pdf/components/cover.rb
similarity index 96%
rename from app/models/work_package/pdf_export/export/cover.rb
rename to app/models/exports/pdf/components/cover.rb
index a91eed6ead2..0a06b6766de 100644
--- a/app/models/work_package/pdf_export/export/cover.rb
+++ b/app/models/exports/pdf/components/cover.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Cover
+module Exports::PDF::Components::Cover
def write_cover_page!
write_cover_logo
write_cover_hr
@@ -154,13 +154,7 @@ module WorkPackage::PDFExport::Export::Cover
def write_cover_footer
text_style = styles.cover_footer
text_style[:color] = cover_text_color if cover_text_color.present?
- draw_text_multiline_left(
- text: footer_date,
- max_left: pdf.bounds.width / 2,
- max_lines: 1,
- top: pdf.bounds.bottom - styles.cover_footer_offset,
- text_style:
- )
+ draw_text_left(footer_date, text_style, pdf.bounds.bottom - styles.cover_footer_offset)
end
def write_cover_logo
diff --git a/app/models/work_package/pdf_export/common/styles_cover.rb b/app/models/exports/pdf/components/cover_styles.rb
similarity index 98%
rename from app/models/work_package/pdf_export/common/styles_cover.rb
rename to app/models/exports/pdf/components/cover_styles.rb
index 99e2b792602..590baf06488 100644
--- a/app/models/work_package/pdf_export/common/styles_cover.rb
+++ b/app/models/exports/pdf/components/cover_styles.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Common::StylesCover
+module Exports::PDF::Components::CoverStyles
def cover_header
resolve_font(@styles.dig(:cover, :header))
end
diff --git a/app/models/work_package/pdf_export/export/gantt.rb b/app/models/exports/pdf/components/gantt.rb
similarity index 99%
rename from app/models/work_package/pdf_export/export/gantt.rb
rename to app/models/exports/pdf/components/gantt.rb
index a395b4ce071..8b213b50978 100644
--- a/app/models/work_package/pdf_export/export/gantt.rb
+++ b/app/models/exports/pdf/components/gantt.rb
@@ -45,7 +45,7 @@
# 1. Build the data classes, do the layout, measuring, etc.
# 2. Paint the Gantt chart into the PDF
-module WorkPackage::PDFExport::Export::Gantt
+module Exports::PDF::Components::Gantt
GANTT_DAY_COLUMN_WIDTHS = [64, 32, 24, 18].freeze
GANTT_COLUMN_WIDTHS = [128, 64, 32, 24].freeze
GANTT_COLUMN_WIDTHS_NAMES = %w[very_wide wide medium narrow].freeze
diff --git a/app/models/work_package/pdf_export/export/gantt/gantt_builder.rb b/app/models/exports/pdf/components/gantt/gantt_builder.rb
similarity index 99%
rename from app/models/work_package/pdf_export/export/gantt/gantt_builder.rb
rename to app/models/exports/pdf/components/gantt/gantt_builder.rb
index 4e726f2f424..0a22b54e28f 100644
--- a/app/models/work_package/pdf_export/export/gantt/gantt_builder.rb
+++ b/app/models/exports/pdf/components/gantt/gantt_builder.rb
@@ -26,7 +26,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Gantt
+module Exports::PDF::Components::Gantt
class GanttBuilder
include Redmine::I18n
BAR_CELL_PADDING = 5.to_f
diff --git a/app/models/work_package/pdf_export/export/gantt/gantt_builder_days.rb b/app/models/exports/pdf/components/gantt/gantt_builder_days.rb
similarity index 97%
rename from app/models/work_package/pdf_export/export/gantt/gantt_builder_days.rb
rename to app/models/exports/pdf/components/gantt/gantt_builder_days.rb
index 465a4f9515b..c11315aff3b 100644
--- a/app/models/work_package/pdf_export/export/gantt/gantt_builder_days.rb
+++ b/app/models/exports/pdf/components/gantt/gantt_builder_days.rb
@@ -26,7 +26,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Gantt
+module Exports::PDF::Components::Gantt
class GanttBuilderDays < GanttBuilder
def build_column_dates_range(range)
range.to_a
diff --git a/app/models/work_package/pdf_export/export/gantt/gantt_builder_months.rb b/app/models/exports/pdf/components/gantt/gantt_builder_months.rb
similarity index 98%
rename from app/models/work_package/pdf_export/export/gantt/gantt_builder_months.rb
rename to app/models/exports/pdf/components/gantt/gantt_builder_months.rb
index fe8b8f252d8..e37c3d29f6f 100644
--- a/app/models/work_package/pdf_export/export/gantt/gantt_builder_months.rb
+++ b/app/models/exports/pdf/components/gantt/gantt_builder_months.rb
@@ -26,7 +26,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Gantt
+module Exports::PDF::Components::Gantt
class GanttBuilderMonths < GanttBuilder
def build_column_dates_range(range)
range
diff --git a/app/models/work_package/pdf_export/export/gantt/gantt_builder_quarters.rb b/app/models/exports/pdf/components/gantt/gantt_builder_quarters.rb
similarity index 98%
rename from app/models/work_package/pdf_export/export/gantt/gantt_builder_quarters.rb
rename to app/models/exports/pdf/components/gantt/gantt_builder_quarters.rb
index 664f02d2048..ff6e7e1c634 100644
--- a/app/models/work_package/pdf_export/export/gantt/gantt_builder_quarters.rb
+++ b/app/models/exports/pdf/components/gantt/gantt_builder_quarters.rb
@@ -26,7 +26,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Gantt
+module Exports::PDF::Components::Gantt
class GanttBuilderQuarters < GanttBuilder
def build_column_dates_range(range)
range
diff --git a/app/models/work_package/pdf_export/export/gantt/gantt_builder_weeks.rb b/app/models/exports/pdf/components/gantt/gantt_builder_weeks.rb
similarity index 98%
rename from app/models/work_package/pdf_export/export/gantt/gantt_builder_weeks.rb
rename to app/models/exports/pdf/components/gantt/gantt_builder_weeks.rb
index 337f04977d6..6de2bd0abc3 100644
--- a/app/models/work_package/pdf_export/export/gantt/gantt_builder_weeks.rb
+++ b/app/models/exports/pdf/components/gantt/gantt_builder_weeks.rb
@@ -26,7 +26,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Gantt
+module Exports::PDF::Components::Gantt
class GanttBuilderWeeks < GanttBuilder
def build_column_dates_range(range)
range
diff --git a/app/models/work_package/pdf_export/export/gantt/gantt_painter.rb b/app/models/exports/pdf/components/gantt/gantt_painter.rb
similarity index 99%
rename from app/models/work_package/pdf_export/export/gantt/gantt_painter.rb
rename to app/models/exports/pdf/components/gantt/gantt_painter.rb
index 4247900974b..6551f2b3136 100644
--- a/app/models/work_package/pdf_export/export/gantt/gantt_painter.rb
+++ b/app/models/exports/pdf/components/gantt/gantt_painter.rb
@@ -26,7 +26,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Gantt
+module Exports::PDF::Components::Gantt
class GanttPainter
GANTT_GRID_COLOR = "9b9ea3".freeze
GANTT_LINE_COLOR = "2b8bd5".freeze
diff --git a/app/models/work_package/pdf_export/export/page.rb b/app/models/exports/pdf/components/page.rb
similarity index 79%
rename from app/models/work_package/pdf_export/export/page.rb
rename to app/models/exports/pdf/components/page.rb
index c82ac189acb..d2e8d2781e3 100644
--- a/app/models/work_package/pdf_export/export/page.rb
+++ b/app/models/exports/pdf/components/page.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Page
+module Exports::PDF::Components::Page
MAX_NR_OF_PDF_FOOTER_LINES = 3
def configure_page_size!(layout)
@@ -61,7 +61,7 @@ module WorkPackage::PDFExport::Export::Page
end
def logo_pdf_top
- pdf.bounds.top + styles.page_header_offset + (styles.page_logo_height / 2)
+ pdf.bounds.top + styles.page_header_offset + styles.page_logo_offset + (styles.page_logo_height / 2)
end
def logo_pdf_image
@@ -95,27 +95,22 @@ module WorkPackage::PDFExport::Export::Page
top = styles.page_footer_offset
text_style = styles.page_footer
spacing = styles.page_footer_horizontal_spacing
- page_nr_x, page_nr_width = draw_text_centered(footer_page_nr, text_style, top)
- draw_footer_on_page_left(page_nr_x, text_style, spacing, top)
- draw_footer_on_page_right(page_nr_x, page_nr_width, text_style, spacing, top)
- end
-
- def draw_footer_on_page_right(page_nr_x, page_nr_width, text_style, spacing, top)
+ right_width = footer_page_nr.present? ? draw_text_right(footer_page_nr, text_style, top) : 0
+ left_width = footer_date.present? ? draw_text_left(footer_date, text_style, top) : 0
if footer_title.present?
- draw_text_multiline_right(
- text: footer_title, max_left: page_nr_x + page_nr_width + spacing,
- text_style:, top:, max_lines: MAX_NR_OF_PDF_FOOTER_LINES
+ footer_sides = [left_width, right_width].max + spacing
+ available_width = pdf.bounds.width - (2 * footer_sides)
+ draw_text_multiline_center(
+ text: footer_title,
+ text_style:,
+ left: footer_sides,
+ available_width:,
+ top:,
+ max_lines: MAX_NR_OF_PDF_FOOTER_LINES
)
end
end
- def draw_footer_on_page_left(page_nr_x, text_style, spacing, top)
- draw_text_multiline_left(
- text: footer_date, max_left: page_nr_x - spacing,
- text_style:, top:, max_lines: MAX_NR_OF_PDF_FOOTER_LINES
- )
- end
-
def footer_page_nr
current_page_nr.to_s + total_page_nr_text
end
diff --git a/app/models/work_package/pdf_export/common/styles_page.rb b/app/models/exports/pdf/components/page_styles.rb
similarity index 95%
rename from app/models/work_package/pdf_export/common/styles_page.rb
rename to app/models/exports/pdf/components/page_styles.rb
index 3c6ba4d972e..58339ab8cbf 100644
--- a/app/models/work_package/pdf_export/common/styles_page.rb
+++ b/app/models/exports/pdf/components/page_styles.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Common::StylesPage
+module Exports::PDF::Components::PageStyles
def page_size
@styles[:page_size] || "A4"
end
@@ -49,6 +49,10 @@ module WorkPackage::PDFExport::Common::StylesPage
resolve_pt(@styles.dig(:page_logo, :height), 20)
end
+ def page_logo_offset
+ resolve_pt(@styles.dig(:page_logo, :offset), 0)
+ end
+
def page_logo_align
@styles.dig(:page_logo, :align) || :right
end
diff --git a/app/models/work_package/pdf_export/export/wp_table.rb b/app/models/exports/pdf/components/wp_table.rb
similarity index 99%
rename from app/models/work_package/pdf_export/export/wp_table.rb
rename to app/models/exports/pdf/components/wp_table.rb
index 75cd1f0f3aa..c2c16c7de89 100644
--- a/app/models/work_package/pdf_export/export/wp_table.rb
+++ b/app/models/exports/pdf/components/wp_table.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::WpTable
+module Exports::PDF::Components::WpTable
def write_work_packages_table!(work_packages, query)
columns = limit_table_columns_objects(query)
if query.grouped?
diff --git a/app/models/work_package/pdf_export/common/styles_wp_table.rb b/app/models/exports/pdf/components/wp_table_styles.rb
similarity index 93%
rename from app/models/work_package/pdf_export/common/styles_wp_table.rb
rename to app/models/exports/pdf/components/wp_table_styles.rb
index 95974dc9a4c..d9f62374f12 100644
--- a/app/models/work_package/pdf_export/common/styles_wp_table.rb
+++ b/app/models/exports/pdf/components/wp_table_styles.rb
@@ -28,11 +28,15 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Common::StylesWpTable
+module Exports::PDF::Components::WpTableStyles
def wp_table_group_header
resolve_font(@styles.dig(:wp_table, :group_heading))
end
+ def wp_tables_margins
+ resolve_margin(@styles.dig(:wp_table, :margins))
+ end
+
def wp_table_group_header_margins
resolve_margin(@styles.dig(:wp_table, :group_heading))
end
diff --git a/app/models/work_package/pdf_export/common/styles_attributes_table.rb b/app/models/work_package/pdf_export/common/attributes_table_styles.rb
similarity index 95%
rename from app/models/work_package/pdf_export/common/styles_attributes_table.rb
rename to app/models/work_package/pdf_export/common/attributes_table_styles.rb
index fc32e9c148f..a82aa60c552 100644
--- a/app/models/work_package/pdf_export/common/styles_attributes_table.rb
+++ b/app/models/work_package/pdf_export/common/attributes_table_styles.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Common::StylesAttributesTable
+module WorkPackage::PDFExport::Common::AttributesTableStyles
def wp_attributes_group_label_margins
resolve_margin(@styles.dig(:work_package, :attributes_group))
end
@@ -44,7 +44,7 @@ module WorkPackage::PDFExport::Common::StylesAttributesTable
}
end
- def wp_markdown_label_margins
+ def markdown_field_label_margins
resolve_margin(@styles.dig(:work_package, :attributes_group))
end
diff --git a/app/models/work_package/pdf_export/export/markdown_field.rb b/app/models/work_package/pdf_export/common/markdown_field.rb
similarity index 82%
rename from app/models/work_package/pdf_export/export/markdown_field.rb
rename to app/models/work_package/pdf_export/common/markdown_field.rb
index 4b657a9243b..45ec73675d8 100644
--- a/app/models/work_package/pdf_export/export/markdown_field.rb
+++ b/app/models/work_package/pdf_export/common/markdown_field.rb
@@ -28,9 +28,9 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::MarkdownField
- include WorkPackage::PDFExport::Export::Markdown
- include WorkPackage::PDFExport::Common::Macro
+module WorkPackage::PDFExport::Common::MarkdownField
+ include Exports::PDF::Common::Markdown
+ include Exports::PDF::Common::Macro
def write_markdown_field!(work_package, markdown, label)
return if markdown.blank?
@@ -43,17 +43,17 @@ module WorkPackage::PDFExport::Export::MarkdownField
private
def write_markdown_field_label(label)
- with_margin(styles.wp_markdown_label_margins) do
- pdf.formatted_text([styles.wp_markdown_label.merge({ text: label })])
+ with_margin(styles.markdown_field_label_margins) do
+ pdf.formatted_text([styles.markdown_field_label.merge({ text: label })])
end
end
def write_markdown_field_value(work_package, markdown)
- with_margin(styles.wp_markdown_margins) do
+ with_margin(styles.markdown_field_margins) do
write_markdown!(
apply_markdown_field_macros(markdown,
{ work_package:, project: work_package.project, user: User.current }),
- styles.wp_markdown_styling_yml
+ styles.markdown_field_styling_yml
)
end
end
diff --git a/app/models/work_package/pdf_export/common/styles_markdown.rb b/app/models/work_package/pdf_export/common/markdown_field_styles.rb
similarity index 89%
rename from app/models/work_package/pdf_export/common/styles_markdown.rb
rename to app/models/work_package/pdf_export/common/markdown_field_styles.rb
index c8298f10b9a..a3ca35e847c 100644
--- a/app/models/work_package/pdf_export/common/styles_markdown.rb
+++ b/app/models/work_package/pdf_export/common/markdown_field_styles.rb
@@ -28,20 +28,20 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Common::StylesMarkdown
- def wp_markdown_label
+module WorkPackage::PDFExport::Common::MarkdownFieldStyles
+ def markdown_field_label
resolve_font(@styles.dig(:work_package, :markdown_label))
end
- def wp_markdown_label_margins
+ def markdown_field_label_margins
resolve_margin(@styles.dig(:work_package, :markdown_label))
end
- def wp_markdown_margins
+ def markdown_field_margins
resolve_margin(@styles.dig(:work_package, :markdown_margin))
end
- def wp_markdown_styling_yml
+ def markdown_field_styling_yml
resolve_markdown_styling(@styles.dig(:work_package, :markdown) || {})
end
end
diff --git a/app/models/work_package/pdf_export/document_generator.rb b/app/models/work_package/pdf_export/document_generator.rb
index ccc0694d875..81f7bf25961 100644
--- a/app/models/work_package/pdf_export/document_generator.rb
+++ b/app/models/work_package/pdf_export/document_generator.rb
@@ -29,10 +29,10 @@
#++
class WorkPackage::PDFExport::DocumentGenerator < Exports::Exporter
- include WorkPackage::PDFExport::Common::Common
- include WorkPackage::PDFExport::Common::Attachments
- include WorkPackage::PDFExport::Common::Logo
- include WorkPackage::PDFExport::Common::Macro
+ include Exports::PDF::Common::Common
+ include Exports::PDF::Common::Attachments
+ include Exports::PDF::Common::Logo
+ include Exports::PDF::Common::Macro
include WorkPackage::PDFExport::Generator::Generator
attr_accessor :pdf
diff --git a/app/models/work_package/pdf_export/generator/generator.rb b/app/models/work_package/pdf_export/generator/generator.rb
index 77c62858e8d..aaf20aa824d 100644
--- a/app/models/work_package/pdf_export/generator/generator.rb
+++ b/app/models/work_package/pdf_export/generator/generator.rb
@@ -39,6 +39,7 @@ module WorkPackage::PDFExport::Generator::Generator
def initialize(styling_yml)
symbol_yml = symbolize(styling_yml)
+ symbol_yml[:page][:font] = Exports::PDF::Common::View::default_font
validate_schema!(symbol_yml, styles_schema)
@styles = MarkdownToPDF::Styles.new(symbol_yml)
init_options({ auto_generate_header_ids: false })
diff --git a/app/models/work_package/pdf_export/export/report/attributes.rb b/app/models/work_package/pdf_export/report/attributes.rb
similarity index 98%
rename from app/models/work_package/pdf_export/export/report/attributes.rb
rename to app/models/work_package/pdf_export/report/attributes.rb
index e69b2478d63..b2ef78c0941 100644
--- a/app/models/work_package/pdf_export/export/report/attributes.rb
+++ b/app/models/work_package/pdf_export/report/attributes.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Report::Attributes
+module WorkPackage::PDFExport::Report::Attributes
def write_attributes_tables!(work_package)
rows = attribute_table_rows(work_package)
return if rows.empty?
diff --git a/app/models/work_package/pdf_export/export/report/detail.rb b/app/models/work_package/pdf_export/report/detail.rb
similarity index 98%
rename from app/models/work_package/pdf_export/export/report/detail.rb
rename to app/models/work_package/pdf_export/report/detail.rb
index 1da99b17477..90d9d728d0f 100644
--- a/app/models/work_package/pdf_export/export/report/detail.rb
+++ b/app/models/work_package/pdf_export/report/detail.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Report::Detail
+module WorkPackage::PDFExport::Report::Detail
def write_work_packages_details!(work_packages, id_wp_meta_map)
work_packages.each do |work_package|
write_work_package_detail!(work_package, id_wp_meta_map[work_package.id])
diff --git a/app/models/work_package/pdf_export/export/report/schema.json b/app/models/work_package/pdf_export/report/schema.json
similarity index 99%
rename from app/models/work_package/pdf_export/export/report/schema.json
rename to app/models/work_package/pdf_export/report/schema.json
index c4c10eddb98..89decc227e7 100644
--- a/app/models/work_package/pdf_export/export/report/schema.json
+++ b/app/models/work_package/pdf_export/report/schema.json
@@ -1,7 +1,6 @@
{
"type" : "object",
"title" : "Report, Gantt and Table PDF",
- "description" : "This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/app/models/work_package/pdf_export/report/standard.yml)",
"properties" : {
"page" : {
"$ref" : "#/$defs/page"
diff --git a/app/models/work_package/pdf_export/export/report/standard.yml b/app/models/work_package/pdf_export/report/standard.yml
similarity index 100%
rename from app/models/work_package/pdf_export/export/report/standard.yml
rename to app/models/work_package/pdf_export/report/standard.yml
diff --git a/app/models/work_package/pdf_export/export/report/styles.rb b/app/models/work_package/pdf_export/report/styles.rb
similarity index 86%
rename from app/models/work_package/pdf_export/export/report/styles.rb
rename to app/models/work_package/pdf_export/report/styles.rb
index 2d07a22342b..e85fda483ec 100644
--- a/app/models/work_package/pdf_export/export/report/styles.rb
+++ b/app/models/work_package/pdf_export/report/styles.rb
@@ -28,16 +28,16 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Report::Styles
+module WorkPackage::PDFExport::Report::Styles
class PDFStyles
include MarkdownToPDF::Common
include MarkdownToPDF::StyleHelper
- include WorkPackage::PDFExport::Common::Styles
- include WorkPackage::PDFExport::Common::StylesPage
- include WorkPackage::PDFExport::Common::StylesCover
- include WorkPackage::PDFExport::Common::StylesMarkdown
- include WorkPackage::PDFExport::Common::StylesWpTable
- include WorkPackage::PDFExport::Common::StylesAttributesTable
+ include Exports::PDF::Common::Styles
+ include Exports::PDF::Components::PageStyles
+ include Exports::PDF::Components::CoverStyles
+ include Exports::PDF::Components::WpTableStyles
+ include WorkPackage::PDFExport::Common::MarkdownFieldStyles
+ include WorkPackage::PDFExport::Common::AttributesTableStyles
def toc_max_depth
@styles.dig(:toc, :max_depth) || 4
diff --git a/app/models/work_package/pdf_export/export/report/sums_table.rb b/app/models/work_package/pdf_export/report/sums_table.rb
similarity index 98%
rename from app/models/work_package/pdf_export/export/report/sums_table.rb
rename to app/models/work_package/pdf_export/report/sums_table.rb
index e95e4863a51..031e5b34faa 100644
--- a/app/models/work_package/pdf_export/export/report/sums_table.rb
+++ b/app/models/work_package/pdf_export/report/sums_table.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Report::SumsTable
+module WorkPackage::PDFExport::Report::SumsTable
def write_work_packages_sums!(_work_packages)
return unless has_summable_column?
diff --git a/app/models/work_package/pdf_export/export/report/table_of_contents.rb b/app/models/work_package/pdf_export/report/table_of_contents.rb
similarity index 98%
rename from app/models/work_package/pdf_export/export/report/table_of_contents.rb
rename to app/models/work_package/pdf_export/report/table_of_contents.rb
index e17f0e3f91d..335741a2eef 100644
--- a/app/models/work_package/pdf_export/export/report/table_of_contents.rb
+++ b/app/models/work_package/pdf_export/report/table_of_contents.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Report::TableOfContents
+module WorkPackage::PDFExport::Report::TableOfContents
def write_work_packages_toc!(work_packages, id_wp_meta_map)
toc_list = build_toc_data_list work_packages, id_wp_meta_map
with_margin(styles.toc_margins) do
diff --git a/app/models/work_package/pdf_export/work_package_list_to_pdf.rb b/app/models/work_package/pdf_export/work_package_list_to_pdf.rb
index 12e070543b5..a6c64d066aa 100644
--- a/app/models/work_package/pdf_export/work_package_list_to_pdf.rb
+++ b/app/models/work_package/pdf_export/work_package_list_to_pdf.rb
@@ -42,19 +42,19 @@
require "open3"
class WorkPackage::PDFExport::WorkPackageListToPdf < WorkPackage::Exports::QueryExporter
- include WorkPackage::PDFExport::Common::Common
- include WorkPackage::PDFExport::Common::Logo
- include WorkPackage::PDFExport::Common::Attachments
- include WorkPackage::PDFExport::Export::Page
- include WorkPackage::PDFExport::Export::MarkdownField
- include WorkPackage::PDFExport::Export::Report::Detail
- include WorkPackage::PDFExport::Export::Report::Styles
- include WorkPackage::PDFExport::Export::Report::SumsTable
- include WorkPackage::PDFExport::Export::Report::TableOfContents
- include WorkPackage::PDFExport::Export::Report::Attributes
- include WorkPackage::PDFExport::Export::WpTable
- include WorkPackage::PDFExport::Export::Cover
- include WorkPackage::PDFExport::Export::Gantt
+ include Exports::PDF::Common::Common
+ include Exports::PDF::Common::Logo
+ include Exports::PDF::Common::Attachments
+ include Exports::PDF::Components::Page
+ include Exports::PDF::Components::WpTable
+ include Exports::PDF::Components::Cover
+ include Exports::PDF::Components::Gantt
+ include WorkPackage::PDFExport::Common::MarkdownField
+ include WorkPackage::PDFExport::Report::Detail
+ include WorkPackage::PDFExport::Report::Styles
+ include WorkPackage::PDFExport::Report::SumsTable
+ include WorkPackage::PDFExport::Report::TableOfContents
+ include WorkPackage::PDFExport::Report::Attributes
attr_accessor :pdf,
:options
diff --git a/app/models/work_package/pdf_export/work_package_to_pdf.rb b/app/models/work_package/pdf_export/work_package_to_pdf.rb
index 6ea11a8568e..a7d91a4c544 100644
--- a/app/models/work_package/pdf_export/work_package_to_pdf.rb
+++ b/app/models/work_package/pdf_export/work_package_to_pdf.rb
@@ -29,15 +29,15 @@
#++
class WorkPackage::PDFExport::WorkPackageToPdf < Exports::Exporter
- include WorkPackage::PDFExport::Common::Common
- include WorkPackage::PDFExport::Common::Logo
- include WorkPackage::PDFExport::Common::Attachments
- include WorkPackage::PDFExport::Export::MarkdownField
- include WorkPackage::PDFExport::Export::Page
- include WorkPackage::PDFExport::Export::Wp::Styles
- include WorkPackage::PDFExport::Export::Wp::Attributes
- include WorkPackage::PDFExport::Export::WpTable
- include WorkPackage::PDFExport::Common::Badge
+ include Exports::PDF::Common::Common
+ include Exports::PDF::Common::Logo
+ include Exports::PDF::Common::Attachments
+ include Exports::PDF::Common::Badge
+ include Exports::PDF::Components::Page
+ include Exports::PDF::Components::WpTable
+ include WorkPackage::PDFExport::Wp::Styles
+ include WorkPackage::PDFExport::Wp::Attributes
+ include WorkPackage::PDFExport::Common::MarkdownField
attr_accessor :pdf
diff --git a/app/models/work_package/pdf_export/export/wp/attributes.rb b/app/models/work_package/pdf_export/wp/attributes.rb
similarity index 98%
rename from app/models/work_package/pdf_export/export/wp/attributes.rb
rename to app/models/work_package/pdf_export/wp/attributes.rb
index e1f169c6238..20e5e337d14 100644
--- a/app/models/work_package/pdf_export/export/wp/attributes.rb
+++ b/app/models/work_package/pdf_export/wp/attributes.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Wp::Attributes
+module WorkPackage::PDFExport::Wp::Attributes
include WorkPackage::Exports::Attributes
def write_attributes!(work_package)
@@ -58,7 +58,7 @@ module WorkPackage::PDFExport::Export::Wp::Attributes
end
def write_long_text_custom_field_label(label)
- with_margin(styles.wp_markdown_label_margins) do
+ with_margin(styles.markdown_field_label_margins) do
pdf.formatted_text([styles.wp_attributes_table_label.merge({ text: label })])
end
end
@@ -83,7 +83,7 @@ module WorkPackage::PDFExport::Export::Wp::Attributes
end
def write_inline_error(text)
- with_margin(styles.wp_markdown_label_margins) do
+ with_margin(styles.markdown_field_label_margins) do
pdf.formatted_text([styles.inline_error.merge({ text: })])
end
end
diff --git a/app/models/work_package/pdf_export/export/wp/schema.json b/app/models/work_package/pdf_export/wp/schema.json
similarity index 99%
rename from app/models/work_package/pdf_export/export/wp/schema.json
rename to app/models/work_package/pdf_export/wp/schema.json
index 8a7653b22ba..bc11f9cf9d0 100644
--- a/app/models/work_package/pdf_export/export/wp/schema.json
+++ b/app/models/work_package/pdf_export/wp/schema.json
@@ -1,7 +1,6 @@
{
"type": "object",
"title": "Attributes and description PDF",
- "description": "This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/app/models/work_package/pdf_export/wp/standard.yml)",
"properties": {
"page": {
"$ref": "#/$defs/page"
diff --git a/app/models/work_package/pdf_export/export/wp/standard.yml b/app/models/work_package/pdf_export/wp/standard.yml
similarity index 100%
rename from app/models/work_package/pdf_export/export/wp/standard.yml
rename to app/models/work_package/pdf_export/wp/standard.yml
diff --git a/app/models/work_package/pdf_export/export/wp/styles.rb b/app/models/work_package/pdf_export/wp/styles.rb
similarity index 84%
rename from app/models/work_package/pdf_export/export/wp/styles.rb
rename to app/models/work_package/pdf_export/wp/styles.rb
index e349d407287..55f04fa2424 100644
--- a/app/models/work_package/pdf_export/export/wp/styles.rb
+++ b/app/models/work_package/pdf_export/wp/styles.rb
@@ -28,15 +28,16 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Wp::Styles
+module WorkPackage::PDFExport::Wp::Styles
class PDFStyles
include MarkdownToPDF::Common
include MarkdownToPDF::StyleHelper
- include WorkPackage::PDFExport::Common::Styles
- include WorkPackage::PDFExport::Common::StylesPage
- include WorkPackage::PDFExport::Common::StylesMarkdown
- include WorkPackage::PDFExport::Common::StylesWpTable
- include WorkPackage::PDFExport::Common::StylesAttributesTable
+ include Exports::PDF::Common::Styles
+ include Exports::PDF::Common::Logo
+ include Exports::PDF::Components::WpTableStyles
+ include Exports::PDF::Components::PageStyles
+ include WorkPackage::PDFExport::Common::MarkdownFieldStyles
+ include WorkPackage::PDFExport::Common::AttributesTableStyles
def wp_margins
resolve_margin(@styles[:work_package])
diff --git a/docs/system-admin-guide/design/pdf-export-styles/attributes-and-description/README.md b/docs/system-admin-guide/design/pdf-export-styles/attributes-and-description/README.md
index 508c7cdeaa5..895e60dd0f5 100644
--- a/docs/system-admin-guide/design/pdf-export-styles/attributes-and-description/README.md
+++ b/docs/system-admin-guide/design/pdf-export-styles/attributes-and-description/README.md
@@ -1,7 +1,7 @@
# Attributes and description PDF
-This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/app/models/work_package/pdf_export/wp/standard.yml)
+This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/app/models/work_package/pdf_export/wp/standard.yml).
| Key | Description | Data type |
| - | - | - |
@@ -90,6 +90,23 @@ border_width_right: 0.5mm
| `no_border_right` | **Disable border right**<br/>Turn off border on the right sides | boolean |
| `no_border_bottom` | **Disable border bottom**<br/>Turn off border on the bottom sides | boolean |
+## Cell alignment properties
+
+Properties to set vertical and horizontal alignment of table cells
+
+Key: `cell_alignment`
+
+Example:
+```yml
+align: center
+valign: middle
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `align` | **Horizontal alignment**<br/>Set the horizontal alignment of the content in a cell<br/>Example: `center`<br/>Valid values:<br/>`left`, `center`, `right` | string |
+| `valign` | **Vertical alignment**<br/>Border width only on the left side<br/>Example: `middle`<br/>Valid values:<br/>`top`, `center`, `middle`, `bottom` | string |
+
## Font properties
Styling for inline error messages
@@ -752,6 +769,7 @@ table_cell:
| … | See [Font properties](#font-properties) | |
| … | See [Padding Properties](#padding-properties) | |
| … | See [Border Properties](#border-properties) | |
+| … | See [Cell alignment properties](#cell-alignment-properties) | |
## Table header cell
@@ -774,6 +792,7 @@ table_header:
| … | See [Font properties](#font-properties) | |
| … | See [Padding Properties](#padding-properties) | |
| … | See [Border Properties](#border-properties) | |
+| … | See [Cell alignment properties](#cell-alignment-properties) | |
## Work package
@@ -966,4 +985,4 @@ available units are
`in` - Inch, `ft` - Feet, `yr` - Yard
-`pt` - [Postscript point](https://en.wikipedia.org/wiki/Point_(typography)#Desktop_publishing_point) (default if no unit is used)
+`pt` - [Postscript point](https://en.wikipedia.org/wiki/Point_(typography)#Desktop_publishing_point) (default if no unit is used)
\ No newline at end of file
diff --git a/docs/system-admin-guide/design/pdf-export-styles/meeting/README.md b/docs/system-admin-guide/design/pdf-export-styles/meeting/README.md
new file mode 100644
index 00000000000..3d484fdd332
--- /dev/null
+++ b/docs/system-admin-guide/design/pdf-export-styles/meeting/README.md
@@ -0,0 +1,1155 @@
+
+# Meetings PDF
+
+This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/modules/meeting/app/workers/meetings/pdf/standard.yml).
+
+| Key | Description | Data type |
+| - | - | - |
+| `page` | **Page settings**<br/>Properties to set the basic page settings<br/>See [Page settings](#page-settings) | object |
+| `page_logo` | **Page logo**<br/>Styling for logo image in the page header.<br/>See [Page logo](#page-logo) | object |
+| `page_header` | **Page headers**<br/>See [Page headers](#page-headers) | object |
+| `page_footer` | **Page footers**<br/>See [Page footers](#page-footers) | object |
+| `page_heading` | **Page heading**<br/>The main page title heading<br/>See [Page heading](#page-heading) | object |
+| `page_subtitle` | **Page heading**<br/>The main page title heading<br/>See [Page heading](#page-heading) | object |
+| `cover` | **Cover page**<br/>Styling for the cover page of the PDF report export<br/>See [Cover page](#cover-page) | object |
+| `notes` | **Agenda item notes**<br/>Styling for Meeting agenda item notes<br/>See [Agenda item notes](#agenda-item-notes) | object |
+| `outcome` | **Agenda item outcome**<br/>Styling for Meeting agenda item outcome<br/>See [Agenda item outcome](#agenda-item-outcome) | object |
+| `heading` | **Heading**<br/>Styling for the heading of the PDF meeting export<br/>See [Heading](#heading) | object |
+| `agenda_item` | **Agenda item**<br/>Styling for a agenda item of the PDF meeting export<br/>See [Agenda item](#agenda-item) | object |
+| `agenda_section` | **Agenda section**<br/>Styling for a agenda section of the PDF meeting export<br/>See [Agenda section](#agenda-section) | object |
+| `participants` | **Participants**<br/>Styling for the participants table<br/>See [Participants](#participants) | object |
+| `attachments` | **Attachments**<br/>Styling for the attachments table<br/>See [Attachments](#attachments) | object |
+
+## Agenda item
+
+Styling for a agenda item of the PDF meeting export
+
+Key: `agenda_item`
+
+Example:
+```yml
+agenda_item: {}
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `title_cell` | **Agenda item title table cell**<br/>Styling for a table cell with the agenda item title<br/>See [Table cell](#table-cell) | object |
+| `title` | **Font properties**<br/>Properties to set the font style<br/>See [Font properties](#font-properties) | object |
+| `subtitle` | **Font properties**<br/>Properties to set the font style<br/>See [Font properties](#font-properties) | object |
+| `title_margin` | **Margin properties**<br/>Properties to set margins<br/>See [Margin properties](#margin-properties) | object |
+| `indent` | **Indent width**<br/>Indent for agenda item notes<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `hr` | **Horizontal rule between agenda items**<br/>See [Horizontal rule between agenda items](#horizontal-rule-between-agenda-items) | object |
+
+## Agenda item notes
+
+Styling for Meeting agenda item notes
+
+Key: `notes`
+
+Example:
+```yml
+notes:
+ markdown_margin: {}
+ markdown: {}
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `markdown_margin` | **Agenda item notes markdown margins**<br/>Margins for agenda item notes<br/>See [Agenda item notes markdown margins](#agenda-item-notes-markdown-margins) | object |
+| `markdown` | **Markdown Styling**<br/>Styling for markdown content of agenda item notes<br/>See [Markdown Styling](#markdown-styling) | object |
+| … | See [Margin properties](#margin-properties) | |
+
+## Agenda item notes markdown margins
+
+Margins for agenda item notes
+
+Key: `markdown_margin`
+
+Example:
+```yml
+markdown_margin:
+ margin_bottom: 16
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| … | See [Margin properties](#margin-properties) | |
+
+## Agenda item outcome
+
+Styling for Meeting agenda item outcome
+
+Key: `outcome`
+
+Example:
+```yml
+outcome:
+ indent: 15
+ markdown_margin: {}
+ markdown: {}
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `title` | **Agenda item outcome title**<br/>See [Agenda item outcome title](#agenda-item-outcome-title) | object |
+| `symbol` | **Agenda item outcome symbol**<br/>See [Agenda item outcome symbol](#agenda-item-outcome-symbol) | object |
+| `indent` | **Indent width**<br/>Indent for agenda item notes<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `markdown_margin` | **Agenda item outcome markdown margins**<br/>Margins for agenda item outcome<br/>See [Agenda item outcome markdown margins](#agenda-item-outcome-markdown-margins) | object |
+| `markdown` | **Markdown Styling**<br/>Styling for markdown content of agenda item notes<br/>See [Markdown Styling](#markdown-styling) | object |
+| … | See [Margin properties](#margin-properties) | |
+
+## Agenda item outcome markdown margins
+
+Margins for agenda item outcome
+
+Key: `markdown_margin`
+
+Example:
+```yml
+markdown_margin:
+ margin_bottom: 16
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| … | See [Margin properties](#margin-properties) | |
+
+## Agenda item outcome symbol
+
+Key: `symbol`
+
+| Key | Description | Data type |
+| - | - | - |
+| … | See [Font properties](#font-properties) | |
+
+## Agenda item outcome title
+
+Key: `title`
+
+| Key | Description | Data type |
+| - | - | - |
+| … | See [Font properties](#font-properties) | |
+| … | See [Margin properties](#margin-properties) | |
+
+## Agenda section
+
+Styling for a agenda section of the PDF meeting export
+
+Key: `agenda_section`
+
+Example:
+```yml
+agenda_section: {}
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `title_cell` | **Agenda section title table cell**<br/>Styling for a table cell with the agenda section title<br/>See [Table cell](#table-cell) | object |
+| `title` | **Font properties**<br/>Properties to set the font style<br/>See [Font properties](#font-properties) | object |
+| `subtitle` | **Font properties**<br/>Properties to set the font style<br/>See [Font properties](#font-properties) | object |
+| `title_margins` | **Margin properties**<br/>Properties to set margins<br/>See [Margin properties](#margin-properties) | object |
+
+## Alert
+
+Styling to denote a quote as alert box
+
+Key: `alert`
+
+Example:
+```yml
+ALERT:
+ alert_color: f4f9ff
+ border_color: f4f9ff
+ border_width: 2
+ no_border_right: true
+ no_border_left: false
+ no_border_bottom: true
+ no_border_top: true
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `background_color` | **Color**<br/>A color in RRGGBB format<br/>Example: `F0F0F0` | string |
+| `alert_color` | **Color**<br/>A color in RRGGBB format<br/>Example: `F0F0F0` | string |
+| … | See [Font properties](#font-properties) | |
+| … | See [Border Properties](#border-properties) | |
+| … | See [Padding Properties](#padding-properties) | |
+| … | See [Margin properties](#margin-properties) | |
+
+## Alert boxes (styled blockquotes)
+
+Key: `alerts`
+
+| Key | Description | Data type |
+| - | - | - |
+| `NOTE` | **Alert**<br/>Styling to denote a quote as alert box<br/>See [Alert](#alert) | object |
+| `TIP` | **Alert**<br/>Styling to denote a quote as alert box<br/>See [Alert](#alert) | object |
+| `WARNING` | **Alert**<br/>Styling to denote a quote as alert box<br/>See [Alert](#alert) | object |
+| `IMPORTANT` | **Alert**<br/>Styling to denote a quote as alert box<br/>See [Alert](#alert) | object |
+| `CAUTION` | **Alert**<br/>Styling to denote a quote as alert box<br/>See [Alert](#alert) | object |
+
+## Attachments
+
+Styling for the attachments table
+
+Key: `attachments`
+
+Example:
+```yml
+margin_bottom: 12
+cell:
+ size: 10
+ padding_left: 0
+ no_border: true
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `cell` | **Attachments table cell**<br/>Styling for a table cell with a attachment name<br/>See [Table cell](#table-cell) | object |
+| … | See [Margin properties](#margin-properties) | |
+
+## Border Properties
+
+Properties to set borders
+
+Key: `border`
+
+Example:
+```yml
+border_color: F000FF
+border_color_top: 000FFF
+border_color_bottom: FFF000
+no_border_left: true
+no_border_right: true
+border_width: 0.25mm
+border_width_left: 0.5mm
+border_width_right: 0.5mm
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `border_width` | **Border width**<br/>One value for border line width on all sides<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `border_width_left` | **Border width left**<br/>Border width only on the left side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `border_width_top` | **Border width top**<br/>Border width only on the top side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `border_width_right` | **Border width right**<br/>Border width only on the right side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `border_width_bottom` | **Border width bottom**<br/>Border width only on the bottom side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `border_color` | **Border color**<br/>One value for border color on all sides<br/>Example: `F0F0F0` | string |
+| `border_color_left` | **Border color left**<br/>Border color only on the left side<br/>Example: `F0F0F0` | string |
+| `border_color_top` | **Border color top**<br/>Border color only on the top side<br/>Example: `F0F0F0` | string |
+| `border_color_right` | **Border color right**<br/>Border color only on the right side<br/>Example: `F0F0F0` | string |
+| `border_color_bottom` | **Border color bottom**<br/>Border color only on the bottom side<br/>Example: `F0F0F0` | string |
+| `no_border` | **Disable borders**<br/>Turn off borders on all sides | boolean |
+| `no_border_left` | **Disable border left**<br/>Turn off border on the left sides | boolean |
+| `no_border_top` | **Disable border top**<br/>Turn off border on the top sides | boolean |
+| `no_border_right` | **Disable border right**<br/>Turn off border on the right sides | boolean |
+| `no_border_bottom` | **Disable border bottom**<br/>Turn off border on the bottom sides | boolean |
+
+## Cell alignment properties
+
+Properties to set vertical and horizontal alignment of table cells
+
+Key: `cell_alignment`
+
+Example:
+```yml
+align: center
+valign: middle
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `align` | **Horizontal alignment**<br/>Set the horizontal alignment of the content in a cell<br/>Example: `center`<br/>Valid values:<br/>`left`, `center`, `right` | string |
+| `valign` | **Vertical alignment**<br/>Border width only on the left side<br/>Example: `middle`<br/>Valid values:<br/>`top`, `center`, `middle`, `bottom` | string |
+
+## Cover page
+
+Styling for the cover page of the PDF report export
+
+Key: `cover`
+
+Example:
+```yml
+cover:
+ header: {}
+ footer: {}
+ hero: {}
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `header` | **Cover page header**<br/>Styling for the cover page header<br/>See [Cover page header](#cover-page-header) | object |
+| `footer` | **Cover page footer**<br/>Styling for the cover page footer<br/>See [Cover page footer](#cover-page-footer) | object |
+| `hero` | **Cover page hero**<br/>Styling for the hero banner at the bottom at the cover page<br/>See [Cover page hero](#cover-page-hero) | object |
+
+## Cover page footer
+
+Styling for the cover page footer of the PDF report export
+
+Key: `cover_footer`
+
+Example:
+```yml
+footer:
+ offset: 20
+ size: 10
+ color: 064e80
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `offset` | **Offset position from page bottom**<br/>A number >= 0 and an optional unit<br/>Example: `30` | number or string<br/>See [Units](#units) |
+| … | See [Font properties](#font-properties) | |
+
+## Cover page header
+
+Styling for the cover page header of the PDF report export
+
+Key: `cover_header`
+
+Example:
+```yml
+header:
+ logo_height: 25
+ border: {}
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `spacing` | **Minimum spacing between logo and page header text**<br/>A number >= 0 and an optional unit<br/>Example: `20` | number or string<br/>See [Units](#units) |
+| `offset` | **Offset position from page top**<br/>A number >= 0 and an optional unit<br/>Example: `6.5` | number or string<br/>See [Units](#units) |
+| `logo_height` | **Height of the logo in the page header**<br/>A number >= 0 and an optional unit<br/>Example: `25` | number or string<br/>See [Units](#units) |
+| `border` | **Cover page header**<br/>Styling for the cover page header<br/>See [Cover page header border](#cover-page-header-border) | object |
+| … | See [Font properties](#font-properties) | |
+
+## Cover page header border
+
+Styling for the cover page header border of the PDF report export
+
+Key: `cover_header_border`
+
+Example:
+```yml
+border:
+ color: d3dee3
+ height: 1
+ offset: 6
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `spacing` | **Minimum spacing between logo and page header text**<br/>A number >= 0 and an optional unit<br/>Example: `20` | number or string<br/>See [Units](#units) |
+| `offset` | **Offset position from page top**<br/>A number >= 0 and an optional unit<br/>Example: `6` | number or string<br/>See [Units](#units) |
+| `height` | **Line height of the border**<br/>A number >= 0 and an optional unit<br/>Example: `25` | number or string<br/>See [Units](#units) |
+| `color` | **Line color of the border**<br/>A color in RRGGBB format<br/>Example: `F0F0F0` | string |
+| … | See [Font properties](#font-properties) | |
+
+## Cover page hero
+
+Styling for the hero banner at the bottom at the cover page
+
+Key: `cover_hero`
+
+Example:
+```yml
+header:
+ padding_right: 150
+ padding_top: 120
+ title: {}
+ heading: {}
+ subheading: {}
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `padding_right` | **Padding right**<br/>Padding only on the right side of the hero banner<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `padding_top` | **Padding top**<br/>Padding only on the top side of the hero banner<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `title` | **The first block in the hero**<br/>See [The first block in the hero](#the-first-block-in-the-hero) | object |
+| `heading` | **The main block in the hero**<br/>See [The main block in the hero](#the-main-block-in-the-hero) | object |
+| `dates` | **The dates block in the hero**<br/>See [The dates block in the hero](#the-dates-block-in-the-hero) | object |
+| `subheading` | **The last block in the hero**<br/>See [The last block in the hero](#the-last-block-in-the-hero) | object |
+
+## Font properties
+
+Properties to set the font style
+
+Key: `font`
+
+Example:
+```yml
+font: OpenSans
+size: 10
+character_spacing: 0
+styles: []
+color: '000000'
+leading: 2
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `font` | | string |
+| `size` | A number >= 0 and an optional unit<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `character_spacing` | A number >= 0 and an optional unit<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `leading` | A number >= 0 and an optional unit<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `color` | **Color**<br/>A color in RRGGBB format<br/>Example: `F0F0F0` | string |
+| `styles` | Example: `[bold]`<br/>Valid values:<br/>`bold`, `italic`, `underline`, `strikethrough`, `superscript`, `subscript` | array of string |
+
+## HTML table
+
+Key: `html_table`
+
+Example:
+```yml
+table:
+ auto_width: true
+ header:
+ background_color: F0F0F0
+ no_repeating: true
+ size: 12
+ cell:
+ background_color: 000FFF
+ size: 10
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `auto_width` | **Automatic column widths**<br/>Table columns should fit the content, equal spacing of columns if value is `false` | boolean |
+| `header` | **Table header cell**<br/>Styling for a table header cell<br/>See [Table header cell](#table-header-cell) | object |
+| `cell` | **Table cell**<br/>Styling for a table cell<br/>See [Table cell](#table-cell) | object |
+| … | See [Margin properties](#margin-properties) | |
+| … | See [Border Properties](#border-properties) | |
+
+## Heading
+
+Styling for the heading of the PDF meeting export
+
+Key: `heading`
+
+Example:
+```yml
+heading:
+ size: 12
+ styles:
+ - bold
+ margin_bottom: 10
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `hr` | **Horizontal rule before headings**<br/>See [Horizontal rule before headings](#horizontal-rule-before-headings) | object |
+| … | See [Font properties](#font-properties) | |
+| … | See [Margin properties](#margin-properties) | |
+
+## Horizontal rule before headings
+
+Key: `hr`
+
+Example:
+```yml
+border:
+ color: 6E7781
+ height: 1.5
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `height` | **Line height of the horizontal rule**<br/>A number >= 0 and an optional unit<br/>Example: `1` | number or string<br/>See [Units](#units) |
+| `color` | **Line color of the horizontal rule**<br/>A color in RRGGBB format<br/>Example: `F0F0F0` | string |
+| … | See [Margin properties](#margin-properties) | |
+
+## Horizontal rule between agenda items
+
+Key: `hr`
+
+Example:
+```yml
+border:
+ color: D0D7DE
+ height: 1
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `height` | **Line height of the horizontal rule**<br/>A number >= 0 and an optional unit<br/>Example: `1` | number or string<br/>See [Units](#units) |
+| `color` | **Line color of the horizontal rule**<br/>A color in RRGGBB format<br/>Example: `F0F0F0` | string |
+| … | See [Margin properties](#margin-properties) | |
+
+## Image caption
+
+Styling for the caption below an image
+
+Key: `caption`
+
+| Key | Description | Data type |
+| - | - | - |
+| `align` | Valid values:<br/>`left`, `center`, `right`, `justify` | string |
+| … | See [Font properties](#font-properties) | |
+| … | See [Padding Properties](#padding-properties) | |
+
+## Margin properties
+
+Properties to set margins
+
+Key: `margin`
+
+Example:
+```yml
+margin: 10mm
+margin_top: 15mm
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `margin` | **Margin**<br/>One value for margin on all sides<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `margin_left` | **Margin left**<br/>Margin only on the left side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `margin_right` | **Margin right**<br/>Margin only on the right side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `margin_top` | **Margin top**<br/>Margin only on the top side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `margin_bottom` | **Margin bottom**<br/>Margin only on the bottom side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+
+## Markdown Link
+
+Styling a clickable link
+
+Key: `link`
+
+Example:
+```yml
+link:
+ color: '000088'
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| … | See [Font properties](#font-properties) | |
+
+## Markdown Styling
+
+Styling for markdown content of agenda item notes
+
+Key: `markdown`
+
+Example:
+```yml
+markdown:
+ font: {}
+ header: {}
+ header_1: {}
+ header_2: {}
+ header_3: {}
+ paragraph: {}
+ unordered_list: {}
+ unordered_list_point: {}
+ ordered_list: {}
+ ordered_list_point: {}
+ task_list: {}
+ task_list_point: {}
+ link: {}
+ code: {}
+ blockquote: {}
+ codeblock: {}
+ table: {}
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `font` | **Font properties**<br/>Properties to set the font style<br/>See [Font properties](#font-properties) | object |
+| `paragraph` | **Markdown paragraph**<br/>A block of text<br/>See [Markdown paragraph](#markdown-paragraph) | object |
+| `table` | **Markdown table**<br/>See [Markdown table](#markdown-table) | object |
+| `html_table` | **HTML table**<br/>See [HTML table](#html-table) | object |
+| `headless_table` | **Markdown headless table**<br/>Tables without or empty header rows can be styled differently.<br/>See [Markdown headless table](#markdown-headless-table) | object |
+| `code` | **Markdown code**<br/>Styling to denote a word or phrase as code<br/>See [Markdown code](#markdown-code) | object |
+| `codeblock` | **Markdown code block**<br/>Styling to denote a paragraph as code<br/>See [Markdown code block](#markdown-code-block) | object |
+| `link` | **Markdown Link**<br/>Styling a clickable link<br/>See [Markdown Link](#markdown-link) | object |
+| `image` | **Markdown image**<br/>Styling of images<br/>See [Markdown image](#markdown-image) | object |
+| `hrule` | **Markdown horizontal rule**<br/>Styling for horizontal lines<br/>See [Markdown horizontal rule](#markdown-horizontal-rule) | object |
+| `header` | **Markdown header**<br/>Default styling for headers on all levels.<br/>use header_`x` as key for header level `x`.<br/>See [Markdown header](#markdown-header) | object |
+| `blockquote` | **Markdown blockquote**<br/>Styling to denote a paragraph as quote<br/>See [Markdown blockquote](#markdown-blockquote) | object |
+| `ordered_list` | **Markdown ordered list**<br/>Default styling for ordered lists on all levels.<br/>use ordered_list_`x` as key for ordered list level `x`.<br/>See [Markdown ordered list](#markdown-ordered-list) | object |
+| `ordered_list_point` | **Markdown ordered list point**<br/>Default styling for ordered list points on all levels.<br/>use ordered_list_point_`x` as key for ordered list points level `x`.<br/>See [Markdown ordered list point](#markdown-ordered-list-point) | object |
+| `unordered_list` | **Markdown unordered list**<br/>Default styling for unordered lists on all levels.<br/>use unordered_list_`x` as key for unordered list level `x`.<br/>See [Markdown unordered list](#markdown-unordered-list) | object |
+| `unordered_list_point` | **Markdown unordered list point**<br/>Default styling for unordered list points on all levels.<br/>use unordered_list_point_`x` as key for unordered list points level `x`.<br/>See [Markdown unordered list point](#markdown-unordered-list-point) | object |
+| `task_list` | **Markdown task list**<br/>See [Markdown unordered list](#markdown-unordered-list) | object |
+| `task_list_point` | **Markdown task list point**<br/>See [Markdown task list point](#markdown-task-list-point) | object |
+| `alerts` | **Alert boxes (styled blockquotes)**<br/>See [Alert boxes (styled blockquotes)](#alert-boxes-styled-blockquotes) | object |
+| `ordered_list_point_1`<br/>`ordered_list_point_2`<br/>`ordered_list_point_x` | Markdown ordered list point level<br/>See [Markdown ordered list point](#markdown-ordered-list-point) | object |
+| `ordered_list_1`<br/>`ordered_list_2`<br/>`ordered_list_x` | Markdown ordered list level<br/>See [Markdown ordered list](#markdown-ordered-list) | object |
+| `unordered_list_point_1`<br/>`unordered_list_point_2`<br/>`unordered_list_point_x` | Markdown unordered list point level<br/>See [Markdown unordered list point](#markdown-unordered-list-point) | object |
+| `unordered_list_1`<br/>`unordered_list_2`<br/>`unordered_list_x` | Markdown unordered List Level<br/>See [Markdown unordered list](#markdown-unordered-list) | object |
+| `header_1`<br/>`header_2`<br/>`header_x` | Markdown header level<br/>See [Markdown header](#markdown-header) | object |
+
+## Markdown blockquote
+
+Styling to denote a paragraph as quote
+
+Key: `blockquote`
+
+Example:
+```yml
+blockquote:
+ background_color: f4f9ff
+ size: 14
+ styles:
+ - italic
+ color: 0f3b66
+ border_color: b8d6f4
+ border_width: 1
+ no_border_right: true
+ no_border_left: false
+ no_border_bottom: true
+ no_border_top: true
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `background_color` | **Color**<br/>A color in RRGGBB format<br/>Example: `F0F0F0` | string |
+| … | See [Font properties](#font-properties) | |
+| … | See [Border Properties](#border-properties) | |
+| … | See [Padding Properties](#padding-properties) | |
+| … | See [Margin properties](#margin-properties) | |
+
+## Markdown code
+
+Styling to denote a word or phrase as code
+
+Key: `code`
+
+Example:
+```yml
+code:
+ font: Consolas
+ color: '880000'
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| … | See [Font properties](#font-properties) | |
+
+## Markdown code block
+
+Styling to denote a paragraph as code
+
+Key: `codeblock`
+
+Example:
+```yml
+codeblock:
+ background_color: F5F5F5
+ font: Consolas
+ size: 8
+ color: '880000'
+ padding: 3mm
+ margin_top: 2mm
+ margin_bottom: 2mm
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `background_color` | **Color**<br/>A color in RRGGBB format<br/>Example: `F0F0F0` | string |
+| … | See [Font properties](#font-properties) | |
+| … | See [Padding Properties](#padding-properties) | |
+| … | See [Margin properties](#margin-properties) | |
+
+## Markdown header
+
+Key: `header`
+
+Example:
+```yml
+header:
+ styles:
+ - bold
+ padding_top: 2mm
+ padding_bottom: 2mm
+header_1:
+ size: 14
+ styles:
+ - bold
+ - italic
+header_2:
+ size: 12
+ styles:
+ - bold
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| … | See [Font properties](#font-properties) | |
+| … | See [Padding Properties](#padding-properties) | |
+
+## Markdown headless table
+
+Tables without or empty header rows can be styled differently.
+
+Key: `headless_table`
+
+Example:
+```yml
+headless_table:
+ auto_width: true
+ cell:
+ style: underline
+ background_color: 000FFF
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `auto_width` | **Automatic column widths**<br/>Table columns should fit the content, equal spacing of columns if value is `false` | boolean |
+| `cell` | **Table cell**<br/>Styling for a table cell<br/>See [Table cell](#table-cell) | object |
+| … | See [Margin properties](#margin-properties) | |
+| … | See [Border Properties](#border-properties) | |
+
+## Markdown horizontal rule
+
+Styling for horizontal lines
+
+Key: `hrule`
+
+Example:
+```yml
+hrule:
+ line_width: 1
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `line_width` | **Sets the stroke width of the horizontal rule**<br/>A number >= 0 and an optional unit<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| … | See [Margin properties](#margin-properties) | |
+
+## Markdown image
+
+Styling of images
+
+Key: `image`
+
+Example:
+```yml
+image:
+ max_width: 50mm
+ margin: 2mm
+ margin_bottom: 3mm
+ align: center
+ caption:
+ align: center
+ size: 8
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `max_width` | **Maximum width of the image**<br/>A number >= 0 and an optional unit<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `align` | **Alignment**<br/>How the element should be aligned<br/>Example: `center`<br/>Valid values:<br/>`left`, `center`, `right` | string |
+| `caption` | **Image caption**<br/>Styling for the caption below an image<br/>See [Image caption](#image-caption) | object |
+| … | See [Margin properties](#margin-properties) | |
+
+## Markdown ordered list
+
+Key: `ordered_list`
+
+Example:
+```yml
+ordered_list:
+ spacing: 2mm
+ point_inline: false
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `spacing` | **Spacing**<br/>Additional space between list items<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `point_inline` | **Inline Point**<br/>Do not indent paragraph text, but include the point into the first paragraph | boolean |
+| … | See [Font properties](#font-properties) | |
+| … | See [Padding Properties](#padding-properties) | |
+
+## Markdown ordered list point
+
+Key: `ordered_list_point`
+
+Example:
+```yml
+ordered_list_point:
+ template: "<number>."
+ list_style_type: decimal
+ spacing: 0.75mm
+ spanning: true
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `spacing` | A number >= 0 and an optional unit<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `alphabetical` | **Alphabetical bullet points**<br/>(deprecated; use list_style_type) Convert the list item number into a character, eg. `a.` `b.` `c.` | boolean |
+| `list_style_type` | **List style type**<br/>The style of the list bullet points, eg. `decimal`, `lower-latin`, `upper-roman`<br/>Valid values:<br/>`decimal`, `lower-latin`, `lower-roman`, `upper-latin`, `upper-roman` | string |
+| `spanning` | **Spanning**<br/>Use the width of the largest bullet as indention. | boolean |
+| `template` | **Template**<br/>customize what the prefix should contain, eg. `(<number>)` | string |
+| … | See [Font properties](#font-properties) | |
+
+## Markdown paragraph
+
+A block of text
+
+Key: `paragraph`
+
+Example:
+```yml
+paragraph:
+ align: justify
+ padding_bottom: 2mm
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `align` | Valid values:<br/>`left`, `center`, `right`, `justify` | string |
+| … | See [Font properties](#font-properties) | |
+| … | See [Padding Properties](#padding-properties) | |
+
+## Markdown table
+
+Key: `table`
+
+Example:
+```yml
+table:
+ auto_width: true
+ header:
+ background_color: F0F0F0
+ no_repeating: true
+ size: 12
+ cell:
+ background_color: 000FFF
+ size: 10
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `auto_width` | **Automatic column widths**<br/>Table columns should fit the content, equal spacing of columns if value is `false` | boolean |
+| `header` | **Table header cell**<br/>Styling for a table header cell<br/>See [Table header cell](#table-header-cell) | object |
+| `cell` | **Table cell**<br/>Styling for a table cell<br/>See [Table cell](#table-cell) | object |
+| … | See [Margin properties](#margin-properties) | |
+| … | See [Border Properties](#border-properties) | |
+
+## Markdown task list point
+
+Key: `task_list_point`
+
+Example:
+```yml
+task_list_point:
+ checked: "☑"
+ unchecked: "☐"
+ spacing: 0.75mm
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `checked` | **Checked sign**<br/>Sign for checked state of a task list item | string |
+| `unchecked` | **Unchecked sign**<br/>Sign for unchecked state of a task list item | string |
+| `spacing` | **Spacing**<br/>Additional space between point and list item content<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| … | See [Font properties](#font-properties) | |
+
+## Markdown unordered list
+
+Key: `unordered_list`
+
+Example:
+```yml
+unordered_list:
+ spacing: 1.5mm
+ padding_top: 2mm
+ padding_bottom: 2mm
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `spacing` | **Spacing**<br/>Additional space between list items<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| … | See [Font properties](#font-properties) | |
+| … | See [Padding Properties](#padding-properties) | |
+
+## Markdown unordered list point
+
+Key: `unordered_list_point`
+
+Example:
+```yml
+unordered_list_point:
+ sign: "•"
+ spacing: 0.75mm
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `sign` | **Sign**<br/>The 'bullet point' character used in the list | string |
+| `spacing` | **Spacing**<br/>Space between point and list item content<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| … | See [Font properties](#font-properties) | |
+
+## Padding Properties
+
+Properties to set paddings
+
+Key: `padding`
+
+Example:
+```yml
+padding: 10mm
+padding_top: 15mm
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `padding` | **Padding**<br/>One value for padding on all sides<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `padding_left` | **Padding left**<br/>Padding only on the left side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `padding_right` | **Padding right**<br/>Padding only on the right side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `padding_top` | **Padding top**<br/>Padding only on the top side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `padding_bottom` | **Padding bottom**<br/>Padding only on the bottom side<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+
+## Page footers
+
+Key: `page_footer`
+
+Example:
+```yml
+page_footer:
+ offset: -30
+ size: 8
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `offset` | **Offset position from page bottom**<br/>A positive or negative number and an optional unit<br/>Example: `-30` | number or string<br/>See [Units](#units) |
+| `spacing` | **Minimum spacing between different page footers**<br/>A number >= 0 and an optional unit<br/>Example: `8` | number or string<br/>See [Units](#units) |
+| … | See [Font properties](#font-properties) | |
+
+## Page headers
+
+Key: `page_header`
+
+Example:
+```yml
+page_header:
+ align: left
+ offset: 20
+ size: 8
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `align` | **Alignment**<br/>How the element should be aligned<br/>Example: `center`<br/>Valid values:<br/>`left`, `center`, `right` | string |
+| `offset` | **Offset position from page top**<br/>A positive or negative number and an optional unit<br/>Example: `-30` | number or string<br/>See [Units](#units) |
+| … | See [Font properties](#font-properties) | |
+
+## Page heading
+
+The main page title heading
+
+Key: `page_heading`
+
+Example:
+```yml
+page_heading:
+ size: 14
+ styles:
+ - bold
+ margin_bottom: 10
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| … | See [Font properties](#font-properties) | |
+| … | See [Margin properties](#margin-properties) | |
+
+## Page logo
+
+Styling for logo image in the page header.
+
+Key: `page_logo`
+
+Example:
+```yml
+page_logo:
+ height: 20
+ align: right
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `height` | **Height of the image**<br/>A number >= 0 and an optional unit<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| `align` | **Alignment**<br/>How the element should be aligned<br/>Example: `center`<br/>Valid values:<br/>`left`, `center`, `right` | string |
+| `offset` | **Offset position from page top**<br/>A positive or negative number and an optional unit<br/>Example: `-30` | number or string<br/>See [Units](#units) |
+
+## Page settings
+
+Properties to set the basic page settings
+
+Key: `page`
+
+Example:
+```yml
+page:
+ page_size: EXECUTIVE
+ margin_top: 60
+ margin_bottom: 60
+ margin_left: 36
+ margin_right: 36
+ page_break_threshold: 200
+ link_color: 175A8E
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `link_color` | **Link color**<br/>Set the color of clickable links<br/>Example: `F0F0F0` | string |
+| `page_layout` | **Page layout**<br/>The layout of a page<br/>Example: `portrait`<br/>Valid values:<br/>`portrait`, `landscape` | string |
+| `page_size` | **Page size**<br/>The size of a page<br/>Example: `EXECUTIVE`<br/>Valid values:<br/>`EXECUTIVE`, `TABLOID`, `LETTER`, `LEGAL`, `FOLIO`, `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `A6`, `A7`, `A8`, `A9`, `A10`, `B0`, `B1`, `B2`, `B3`, `B4`, `B5`, `B6`, `B7`, `B8`, `B9`, `B10`, `C0`, `C1`, `C2`, `C3`, `C4`, `C5`, `C6`, `C7`, `C8`, `C9`, `C10`, `RA0`, `RA1`, `RA2`, `RA3`, `RA4`, `SRA0`, `SRA1`, `SRA2`, `SRA3`, `SRA4`, `4A0`, `2A0` | string |
+| `page_break_threshold` | **Page break threshold**<br/>If there is a new section, start a new page if space less than the threshold is available<br/>Examples: `10mm`, `10` | number or string<br/>See [Units](#units) |
+| … | Default font settings<br/>See [Font properties](#font-properties) | |
+| … | Page margins<br/>See [Margin properties](#margin-properties) | |
+
+## Participants
+
+Styling for the participants table
+
+Key: `participants`
+
+Example:
+```yml
+margin_bottom: 12
+cell:
+ size: 10
+ padding_left: 0
+ no_border: true
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `status` | **Status**<br/>Styling for the status text in the participants table<br/>See [Font properties](#font-properties) | object |
+| `cell` | **Participant table cell**<br/>Styling for a table cell with a participant name<br/>See [Table cell](#table-cell) | object |
+| … | See [Margin properties](#margin-properties) | |
+
+## Table cell
+
+Styling for a table cell
+
+Key: `table_cell`
+
+Example:
+```yml
+table_cell:
+ size: 9
+ color: '000000'
+ padding: 5
+ border_width: 1
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `background_color` | **Color**<br/>A color in RRGGBB format<br/>Example: `F0F0F0` | string |
+| … | See [Font properties](#font-properties) | |
+| … | See [Padding Properties](#padding-properties) | |
+| … | See [Border Properties](#border-properties) | |
+| … | See [Cell alignment properties](#cell-alignment-properties) | |
+
+## Table header cell
+
+Styling for a table header cell
+
+Key: `table_header`
+
+Example:
+```yml
+table_header:
+ size: 9
+ styles:
+ - bold
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `background_color` | **Color**<br/>A color in RRGGBB format<br/>Example: `F0F0F0` | string |
+| `no_repeating` | | boolean |
+| … | See [Font properties](#font-properties) | |
+| … | See [Padding Properties](#padding-properties) | |
+| … | See [Border Properties](#border-properties) | |
+| … | See [Cell alignment properties](#cell-alignment-properties) | |
+
+## The dates block in the hero
+
+Key: `dates`
+
+Example:
+```yml
+heading:
+ spacing: 10
+ max_height: 20
+ size: 32
+ color: 414d5f
+ styles:
+ - bold
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `max_height` | **Maximum height of the block**<br/>A number >= 0 and an optional unit<br/>Example: `30` | number or string<br/>See [Units](#units) |
+| `spacing` | **Minimum spacing between dates and subheading**<br/>A number >= 0 and an optional unit<br/>Example: `10` | number or string<br/>See [Units](#units) |
+| … | See [Font properties](#font-properties) | |
+
+## The first block in the hero
+
+Key: `title`
+
+Example:
+```yml
+title:
+ max_height: 30
+ spacing: 10
+ font: SpaceMono
+ size: 10
+ color: 414d5f
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `spacing` | **Minimum spacing between title and heading**<br/>A number >= 0 and an optional unit<br/>Example: `10` | number or string<br/>See [Units](#units) |
+| `max_height` | **Maximum height of the block**<br/>A number >= 0 and an optional unit<br/>Example: `30` | number or string<br/>See [Units](#units) |
+| … | See [Font properties](#font-properties) | |
+
+## The last block in the hero
+
+Key: `subheading`
+
+Example:
+```yml
+subheading:
+ max_height: 30
+ size: 10
+ color: 414d5f
+ styles:
+ - italic
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `max_height` | **Maximum height of the block**<br/>A number >= 0 and an optional unit<br/>Example: `30` | number or string<br/>See [Units](#units) |
+| … | See [Font properties](#font-properties) | |
+
+## The main block in the hero
+
+Key: `heading`
+
+Example:
+```yml
+heading:
+ spacing: 10
+ size: 32
+ color: 414d5f
+ styles:
+ - bold
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `spacing` | **Minimum spacing between heading and subheading**<br/>A number >= 0 and an optional unit<br/>Example: `10` | number or string<br/>See [Units](#units) |
+| … | See [Font properties](#font-properties) | |
+
+## Units
+
+available units are
+
+`mm` - Millimeter, `cm` - Centimeter, `dm` - Decimeter, `m` - Meter
+
+`in` - Inch, `ft` - Feet, `yr` - Yard
+
+`pt` - [Postscript point](https://en.wikipedia.org/wiki/Point_(typography)#Desktop_publishing_point) (default if no unit is used)
\ No newline at end of file
diff --git a/docs/system-admin-guide/design/pdf-export-styles/report/README.md b/docs/system-admin-guide/design/pdf-export-styles/report/README.md
index d7d5a7674f7..9673eebe898 100644
--- a/docs/system-admin-guide/design/pdf-export-styles/report/README.md
+++ b/docs/system-admin-guide/design/pdf-export-styles/report/README.md
@@ -1,7 +1,7 @@
# Report, Gantt and Table PDF
-This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/app/models/work_package/pdf_export/report/standard.yml)
+This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/app/models/work_package/pdf_export/report/standard.yml).
| Key | Description | Data type |
| - | - | - |
@@ -90,6 +90,23 @@ border_width_right: 0.5mm
| `no_border_right` | **Disable border right**<br/>Turn off border on the right sides | boolean |
| `no_border_bottom` | **Disable border bottom**<br/>Turn off border on the bottom sides | boolean |
+## Cell alignment properties
+
+Properties to set vertical and horizontal alignment of table cells
+
+Key: `cell_alignment`
+
+Example:
+```yml
+align: center
+valign: middle
+```
+
+| Key | Description | Data type |
+| - | - | - |
+| `align` | **Horizontal alignment**<br/>Set the horizontal alignment of the content in a cell<br/>Example: `center`<br/>Valid values:<br/>`left`, `center`, `right` | string |
+| `valign` | **Vertical alignment**<br/>Border width only on the left side<br/>Example: `middle`<br/>Valid values:<br/>`top`, `center`, `middle`, `bottom` | string |
+
## Cover page
Styling for the cover page of the PDF report export
@@ -877,6 +894,7 @@ table_cell:
| … | See [Font properties](#font-properties) | |
| … | See [Padding Properties](#padding-properties) | |
| … | See [Border Properties](#border-properties) | |
+| … | See [Cell alignment properties](#cell-alignment-properties) | |
## Table header cell
@@ -899,6 +917,7 @@ table_header:
| … | See [Font properties](#font-properties) | |
| … | See [Padding Properties](#padding-properties) | |
| … | See [Border Properties](#border-properties) | |
+| … | See [Cell alignment properties](#cell-alignment-properties) | |
## Table of content
@@ -1215,4 +1234,4 @@ available units are
`in` - Inch, `ft` - Feet, `yr` - Yard
-`pt` - [Postscript point](https://en.wikipedia.org/wiki/Point_(typography)#Desktop_publishing_point) (default if no unit is used)
+`pt` - [Postscript point](https://en.wikipedia.org/wiki/Point_(typography)#Desktop_publishing_point) (default if no unit is used)
\ No newline at end of file
diff --git a/docs/system-admin-guide/design/pdf-export-styles/timesheet/README.md b/docs/system-admin-guide/design/pdf-export-styles/timesheet/README.md
index f0ddef8f886..1d52d3902f0 100644
--- a/docs/system-admin-guide/design/pdf-export-styles/timesheet/README.md
+++ b/docs/system-admin-guide/design/pdf-export-styles/timesheet/README.md
@@ -1,7 +1,7 @@
# Timesheet PDF
-This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/app/models/work_package/pdf_export/timesheet/standard.yml)
+This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/modules/reporting/app/workers/cost_query/pdf/standard.yml).
| Key | Description | Data type |
| - | - | - |
@@ -352,4 +352,4 @@ available units are
`in` - Inch, `ft` - Feet, `yr` - Yard
-`pt` - [Postscript point](https://en.wikipedia.org/wiki/Point_(typography)#Desktop_publishing_point) (default if no unit is used)
+`pt` - [Postscript point](https://en.wikipedia.org/wiki/Point_(typography)#Desktop_publishing_point) (default if no unit is used)
\ No newline at end of file
diff --git a/modules/meeting/app/workers/meetings/exporter.rb b/modules/meeting/app/workers/meetings/pdf/exporter.rb
similarity index 89%
rename from modules/meeting/app/workers/meetings/exporter.rb
rename to modules/meeting/app/workers/meetings/pdf/exporter.rb
index 148fb04c86b..6c7c083ac10 100644
--- a/modules/meeting/app/workers/meetings/exporter.rb
+++ b/modules/meeting/app/workers/meetings/pdf/exporter.rb
@@ -28,17 +28,17 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module Meetings
+module Meetings::PDF
class Exporter < ::Exports::Exporter
- include WorkPackage::PDFExport::Common::Common
- include WorkPackage::PDFExport::Common::Logo
- include WorkPackage::PDFExport::Export::Page
- include WorkPackage::PDFExport::Export::Cover
- include WorkPackage::PDFExport::Export::Markdown
- include WorkPackage::PDFExport::Common::Attachments
- include WorkPackage::PDFExport::Common::Badge
- include WorkPackage::PDFExport::Common::Macro
- include WorkPackage::PDFExport::Export::Meetings::Styles
+ include Exports::PDF::Common::Common
+ include Exports::PDF::Common::Logo
+ include Exports::PDF::Common::Markdown
+ include Exports::PDF::Common::Attachments
+ include Exports::PDF::Common::Badge
+ include Exports::PDF::Common::Macro
+ include Exports::PDF::Components::Page
+ include Exports::PDF::Components::Cover
+ include Meetings::PDF::Styles
include Meetings::PDF::PageHead
include Meetings::PDF::Participants
include Meetings::PDF::Agenda
diff --git a/app/models/work_package/pdf_export/export/meetings/schema.json b/modules/meeting/app/workers/meetings/pdf/schema.json
similarity index 99%
rename from app/models/work_package/pdf_export/export/meetings/schema.json
rename to modules/meeting/app/workers/meetings/pdf/schema.json
index e59ef514866..5f09151e0e5 100644
--- a/app/models/work_package/pdf_export/export/meetings/schema.json
+++ b/modules/meeting/app/workers/meetings/pdf/schema.json
@@ -1,7 +1,6 @@
{
"type": "object",
"title": "Meetings PDF",
- "description": "This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/app/models/work_package/pdf_export/meetings/standard.yml)",
"properties": {
"page": {
"$ref": "#/$defs/page"
diff --git a/app/models/work_package/pdf_export/export/meetings/standard.yml b/modules/meeting/app/workers/meetings/pdf/standard.yml
similarity index 100%
rename from app/models/work_package/pdf_export/export/meetings/standard.yml
rename to modules/meeting/app/workers/meetings/pdf/standard.yml
diff --git a/app/models/work_package/pdf_export/export/meetings/styles.rb b/modules/meeting/app/workers/meetings/pdf/styles.rb
similarity index 95%
rename from app/models/work_package/pdf_export/export/meetings/styles.rb
rename to modules/meeting/app/workers/meetings/pdf/styles.rb
index 9a4bfb117f8..af6fe17e231 100644
--- a/app/models/work_package/pdf_export/export/meetings/styles.rb
+++ b/modules/meeting/app/workers/meetings/pdf/styles.rb
@@ -28,13 +28,13 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Meetings::Styles
+module Meetings::PDF::Styles
class PDFStyles
include MarkdownToPDF::Common
include MarkdownToPDF::StyleHelper
- include WorkPackage::PDFExport::Common::Styles
- include WorkPackage::PDFExport::Common::StylesPage
- include WorkPackage::PDFExport::Common::StylesCover
+ include Exports::PDF::Common::Styles
+ include Exports::PDF::Components::PageStyles
+ include Exports::PDF::Components::CoverStyles
def page_subtitle
resolve_font(@styles[:page_subtitle])
diff --git a/modules/meeting/lib/open_project/meeting/engine.rb b/modules/meeting/lib/open_project/meeting/engine.rb
index 84e216310e4..d48d5dbf7df 100644
--- a/modules/meeting/lib/open_project/meeting/engine.rb
+++ b/modules/meeting/lib/open_project/meeting/engine.rb
@@ -183,7 +183,7 @@ module OpenProject::Meeting
PermittedParams.permit(:search, :meetings)
::Exports::Register.register do
- single(::Meeting, Meetings::Exporter)
+ single(::Meeting, Meetings::PDF::Exporter)
end
end
diff --git a/modules/meeting/spec/workers/meetings/exporter_spec.rb b/modules/meeting/spec/workers/meetings/pdf/exporter_spec.rb
similarity index 99%
rename from modules/meeting/spec/workers/meetings/exporter_spec.rb
rename to modules/meeting/spec/workers/meetings/pdf/exporter_spec.rb
index 665266886d2..a190d0ad439 100644
--- a/modules/meeting/spec/workers/meetings/exporter_spec.rb
+++ b/modules/meeting/spec/workers/meetings/pdf/exporter_spec.rb
@@ -31,7 +31,7 @@
require "spec_helper"
require "pdf/inspector"
-RSpec.describe Meetings::Exporter do
+RSpec.describe Meetings::PDF::Exporter do
include Redmine::I18n
shared_let(:role) { create(:project_role, permissions: [:view_work_packages]) }
shared_let(:user) { create(:user, firstname: "Export", lastname: "User") }
diff --git a/app/models/work_package/pdf_export/export/timesheet/schema.json b/modules/reporting/app/workers/cost_query/pdf/schema.json
similarity index 98%
rename from app/models/work_package/pdf_export/export/timesheet/schema.json
rename to modules/reporting/app/workers/cost_query/pdf/schema.json
index 000143a8335..b7a5f7c75bc 100644
--- a/app/models/work_package/pdf_export/export/timesheet/schema.json
+++ b/modules/reporting/app/workers/cost_query/pdf/schema.json
@@ -1,7 +1,6 @@
{
"type" : "object",
"title" : "Timesheet PDF",
- "description" : "This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/app/models/work_package/pdf_export/timesheet/standard.yml)",
"properties" : {
"page" : {
"$ref" : "#/$defs/page"
diff --git a/app/models/work_package/pdf_export/export/timesheet/standard.yml b/modules/reporting/app/workers/cost_query/pdf/standard.yml
similarity index 100%
rename from app/models/work_package/pdf_export/export/timesheet/standard.yml
rename to modules/reporting/app/workers/cost_query/pdf/standard.yml
diff --git a/app/models/work_package/pdf_export/export/timesheet/styles.rb b/modules/reporting/app/workers/cost_query/pdf/styles.rb
similarity index 87%
rename from app/models/work_package/pdf_export/export/timesheet/styles.rb
rename to modules/reporting/app/workers/cost_query/pdf/styles.rb
index 81b44ea6ad5..27a6e69c547 100644
--- a/app/models/work_package/pdf_export/export/timesheet/styles.rb
+++ b/modules/reporting/app/workers/cost_query/pdf/styles.rb
@@ -28,13 +28,13 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module WorkPackage::PDFExport::Export::Timesheet::Styles
+module CostQuery::PDF::Styles
class PDFStyles
include MarkdownToPDF::Common
include MarkdownToPDF::StyleHelper
- include WorkPackage::PDFExport::Common::Styles
- include WorkPackage::PDFExport::Common::StylesPage
- include WorkPackage::PDFExport::Common::StylesCover
+ include Exports::PDF::Common::Styles
+ include Exports::PDF::Components::PageStyles
+ include Exports::PDF::Components::CoverStyles
end
def styles
diff --git a/modules/reporting/app/workers/cost_query/pdf/timesheet_generator.rb b/modules/reporting/app/workers/cost_query/pdf/timesheet_generator.rb
index f3dac27630d..d595782f929 100644
--- a/modules/reporting/app/workers/cost_query/pdf/timesheet_generator.rb
+++ b/modules/reporting/app/workers/cost_query/pdf/timesheet_generator.rb
@@ -29,12 +29,12 @@
#++
class CostQuery::PDF::TimesheetGenerator
- include WorkPackage::PDFExport::Common::Common
- include WorkPackage::PDFExport::Common::Attachments
- include WorkPackage::PDFExport::Common::Logo
- include WorkPackage::PDFExport::Export::Cover
- include WorkPackage::PDFExport::Export::Page
- include WorkPackage::PDFExport::Export::Timesheet::Styles
+ include Exports::PDF::Common::Common
+ include Exports::PDF::Common::Attachments
+ include Exports::PDF::Common::Logo
+ include Exports::PDF::Components::Cover
+ include Exports::PDF::Components::Page
+ include CostQuery::PDF::Styles
include ReportingHelper
H1_FONT_SIZE = 26
diff --git a/modules/reporting/spec/workers/cost_query/pdf/timesheet_generator_spec.rb b/modules/reporting/spec/workers/cost_query/pdf/timesheet_generator_spec.rb
index 38df7ad2d23..3b6889d19e9 100644
--- a/modules/reporting/spec/workers/cost_query/pdf/timesheet_generator_spec.rb
+++ b/modules/reporting/spec/workers/cost_query/pdf/timesheet_generator_spec.rb
@@ -132,8 +132,8 @@ RSpec.describe CostQuery::PDF::TimesheetGenerator do
def expected_entry_columns(t_entry, with_times_column)
time_column = generator.format_spent_on_time(t_entry)
[
- "##{t_entry.work_package.id} ",
- t_entry.work_package&.subject || "",
+ "##{t_entry.entity.id} ",
+ t_entry.entity&.subject || "",
with_times_column && time_column.present? ? time_column : nil,
generator.format_hours(t_entry.hours),
t_entry.activity.name,
@@ -150,7 +150,7 @@ RSpec.describe CostQuery::PDF::TimesheetGenerator do
generator.format_hours(time_entries.select { |entry| entry.user == user }.sum(&:hours)),
time_entry_user.name,
generator.format_hours(time_entries.select { |entry| entry.user == time_entry_user }.sum(&:hours)),
- generator.format_hours(time_entries.sum(&:hours)),
+ generator.format_hours(time_entries.sum(&:hours))
]
end
diff --git a/script/pdf_export/generate_styles_doc b/script/pdf_export/generate_styles_doc
index 33ce5371ea9..97bd079d3fc 100755
--- a/script/pdf_export/generate_styles_doc
+++ b/script/pdf_export/generate_styles_doc
@@ -8,17 +8,15 @@ require "json"
require "fileutils"
root = File.expand_path("../../", __dir__)
-export_folder = File.join(root, "app", "models", "work_package", "pdf_export", "export")
-[
- { type: "wp", docs: "attributes-and-description" },
- { type: "report", docs: "report" },
- { type: "timesheet", docs: "timesheet" }
-].each do |entry|
- schema_file = File.join(export_folder, entry[:type], "schema.json")
+config = YAML.load_file(File.join(__dir__, "styles.yml"))
+
+config["styles"].each do |entry|
+ schema_file = File.join(root, entry["path"], "schema.json")
schema = JSON::load_file(schema_file)
+ schema["description"] = "This document describes the style settings format for the [PDF Export styling file](https://github.com/opf/openproject/blob/dev/#{entry['path']}/standard.yml)."
generator = MarkdownToPDF::StyleSchemaDocsGenerator.new(schema)
markdown = generator.generate_markdown
- styles_doc_folder = File.join(root, "docs", "system-admin-guide", "design", "pdf-export-styles", entry[:docs])
+ styles_doc_folder = File.join(root, "docs", "system-admin-guide", "design", "pdf-export-styles", entry["name"])
FileUtils.mkdir_p(styles_doc_folder)
styles_doc_file = File.join(styles_doc_folder, "README.md")
File.write(styles_doc_file, markdown)
diff --git a/script/pdf_export/styles.yml b/script/pdf_export/styles.yml
new file mode 100644
index 00000000000..4c031000972
--- /dev/null
+++ b/script/pdf_export/styles.yml
@@ -0,0 +1,9 @@
+styles:
+ - name: "attributes-and-description"
+ path: "app/models/work_package/pdf_export/wp"
+ - name: "report"
+ path: "app/models/work_package/pdf_export/report"
+ - name: "timesheet"
+ path: "modules/reporting/app/workers/cost_query/pdf"
+ - name: "meeting"
+ path: "modules/meeting/app/workers/meetings/pdf"
diff --git a/script/pdf_export/validate_styles b/script/pdf_export/validate_styles
index c2ea41c2657..814ec66c986 100755
--- a/script/pdf_export/validate_styles
+++ b/script/pdf_export/validate_styles
@@ -10,11 +10,11 @@ class SchemaValidator
def validate
root = File.expand_path("../../", __dir__)
- export_folder = File.join(root, "app", "models", "work_package", "pdf_export", "export")
- %w[report wp timesheet meetings].each do |type|
- puts "Validating #{type} styles"
- schema = JSON::load_file(File.join(export_folder, type, "schema.json"))
- styles_file = File.join(export_folder, type, "standard.yml")
+ config = YAML.load_file(File.join(__dir__, "styles.yml"))
+ config["styles"].each do |entry|
+ puts "Validating #{entry['name']} styles"
+ schema = JSON::load_file(File.join(root, entry["path"], "schema.json"))
+ styles_file = File.join(root, entry["path"], "standard.yml")
styles = YAML.load_file(styles_file)
validate_schema!(styles, schema)
puts "Valid: #{styles_file}"
diff --git a/spec/models/work_package/pdf_export/common/badge_spec.rb b/spec/models/work_package/pdf_export/common/badge_spec.rb
index 324ee7e4fcd..807b491b153 100644
--- a/spec/models/work_package/pdf_export/common/badge_spec.rb
+++ b/spec/models/work_package/pdf_export/common/badge_spec.rb
@@ -30,8 +30,8 @@
require "spec_helper"
-RSpec.describe WorkPackage::PDFExport::Common::Badge do
- let(:badge) { Class.new { extend WorkPackage::PDFExport::Common::Badge } }
+RSpec.describe Exports::PDF::Common::Badge do
+ let(:badge) { Class.new { extend Exports::PDF::Common::Badge } }
describe "#readable_color" do
describe "returns white for dark colors" do
diff --git a/spec/models/work_package/pdf_export/common/macro_spec.rb b/spec/models/work_package/pdf_export/common/macro_spec.rb
index 45b3a7c1936..039129d057c 100644
--- a/spec/models/work_package/pdf_export/common/macro_spec.rb
+++ b/spec/models/work_package/pdf_export/common/macro_spec.rb
@@ -30,7 +30,7 @@
require "spec_helper"
-RSpec.describe WorkPackage::PDFExport::Common::Macro do
+RSpec.describe Exports::PDF::Common::Macro do
shared_let(:type_task) { create(:type_task) }
shared_let(:custom_field) do
create(
@@ -115,7 +115,7 @@ RSpec.describe WorkPackage::PDFExport::Common::Macro do
}
)
end
- shared_let(:formatter) { Class.new { extend WorkPackage::PDFExport::Common::Macro } }
+ shared_let(:formatter) { Class.new { extend Exports::PDF::Common::Macro } }
let(:additional_permissions) { [] }
let(:user) do
create(