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

page header text on first page

as-opef186eff7b0a
diff --git a/app/models/exports/pdf/common/common.rb b/app/models/exports/pdf/common/common.rb
index bb942445cdd..f9e3e7821a4 100644
--- a/app/models/exports/pdf/common/common.rb
+++ b/app/models/exports/pdf/common/common.rb
@@ -118,7 +118,15 @@ module Exports::PDF::Common::Common
end
end
- def draw_text_multiline_left(text:, text_style:, available_width:, top:, max_lines:)
+ def draw_header_text_multiline_left(text:, text_style:, available_width:, top:, max_lines:)
+ lines = wrap_to_lines(text, available_width, text_style, max_lines)
+ starting_position = top
+ lines.reverse_each do |line|
+ starting_position -= draw_text_multiline_part(line, text_style, 0, starting_position)
+ end
+ end
+
+ def draw_footer_text_multiline_left(text:, text_style:, available_width:, top:, max_lines:)
lines = wrap_to_lines(text, available_width, text_style, max_lines)
starting_position = top
lines.reverse_each do |line|
diff --git a/app/models/exports/pdf/components/page.rb b/app/models/exports/pdf/components/page.rb
index 04b6f632911..cad9dca686d 100644
--- a/app/models/exports/pdf/components/page.rb
+++ b/app/models/exports/pdf/components/page.rb
@@ -29,6 +29,7 @@
#++
module Exports::PDF::Components::Page
+ MAX_NR_OF_PDF_HEADER_LINES = 3
MAX_NR_OF_PDF_FOOTER_LINES = 3
def configure_page_size!(layout)
diff --git a/app/models/exports/pdf/components/page_styles.rb b/app/models/exports/pdf/components/page_styles.rb
index 58339ab8cbf..039e4ce73af 100644
--- a/app/models/exports/pdf/components/page_styles.rb
+++ b/app/models/exports/pdf/components/page_styles.rb
@@ -85,6 +85,10 @@ module Exports::PDF::Components::PageStyles
resolve_font(@styles[:page_header])
end
+ def page_header_width
+ @styles.dig(:page_header, :width).presence || 400
+ end
+
def page_footer
resolve_font(@styles[:page_footer])
end
diff --git a/modules/meeting/app/components/meetings/exports/modal_dialog_component.html.erb b/modules/meeting/app/components/meetings/exports/modal_dialog_component.html.erb
index 61158e23a94..095e70011eb 100644
--- a/modules/meeting/app/components/meetings/exports/modal_dialog_component.html.erb
+++ b/modules/meeting/app/components/meetings/exports/modal_dialog_component.html.erb
@@ -54,7 +54,7 @@
"meetings--export--form-target": "inputGroups"
},
classes: templates_default[:id] == "default" ? nil : "d-none",
- ) do
+ ) do
render(
Primer::Alpha::CheckBox.new(
id: "pdf_include_participants",
@@ -117,6 +117,24 @@
)
end
if OpenProject::FeatureDecisions.minutes_styling_meeting_pdf_active?
+ modal_body.with_row(
+ data: {
+ template: "minutes",
+ "meetings--export--form-target": "inputGroups"
+ },
+ classes: templates_default[:id] == "minutes" ? nil : "d-none",
+ mt: 3
+ ) do
+ render Primer::Alpha::TextField.new(
+ id: "pdf_header_left",
+ name: :page_header_left,
+ label: I18n.t("meeting.export_pdf_dialog.page_header_left.label"),
+ caption: I18n.t("meeting.export_pdf_dialog.page_header_left.caption"),
+ input_width: :large,
+ visually_hide_label: false,
+ value: default_page_header_left_text
+ )
+ end
modal_body.with_row(
data: {
template: "minutes",
@@ -136,7 +154,13 @@
)
end
end
- modal_body.with_row(mt: 3) do
+ modal_body.with_row(
+ mt: 3,
+ data: {
+ template: "default",
+ "meetings--export--form-target": "inputGroups"
+ }
+ ) do
render Primer::Alpha::TextField.new(
id: "pdf_footer_text",
name: :footer_text,
diff --git a/modules/meeting/app/components/meetings/exports/modal_dialog_component.rb b/modules/meeting/app/components/meetings/exports/modal_dialog_component.rb
index bd03ce41b83..739652e529b 100644
--- a/modules/meeting/app/components/meetings/exports/modal_dialog_component.rb
+++ b/modules/meeting/app/components/meetings/exports/modal_dialog_component.rb
@@ -72,6 +72,10 @@ module Meetings
def default_author_text
@meeting.author&.name || User.current.name
end
+
+ def default_page_header_left_text
+ @meeting.project&.name || Setting.software_name
+ end
end
end
end
diff --git a/modules/meeting/app/workers/meetings/pdf/minutes/exporter.rb b/modules/meeting/app/workers/meetings/pdf/minutes/exporter.rb
index cc7e21b02d0..db932fc9b67 100644
--- a/modules/meeting/app/workers/meetings/pdf/minutes/exporter.rb
+++ b/modules/meeting/app/workers/meetings/pdf/minutes/exporter.rb
@@ -87,7 +87,7 @@ module Meetings::PDF::Minutes
def render_meeting
write_page_head
write_agenda
- write_headers!
+ write_minutes_headers
write_minutes_footers
write_footer_logo
end
@@ -133,6 +133,27 @@ module Meetings::PDF::Minutes
meeting.project&.name || ""
end
+ def page_header_text
+ options[:page_header_left] || Setting.software_name
+ end
+
+ def write_minutes_headers
+ write_logo!
+ write_minutes_headers_text
+ end
+
+ def write_minutes_headers_text
+ pdf.repeat lambda { |pg| pg == 1 } do
+ draw_header_text_multiline_left(
+ text: page_header_text,
+ text_style: styles.page_header,
+ available_width: styles.page_header_width,
+ top: pdf.bounds.top + styles.page_logo_height,
+ max_lines: MAX_NR_OF_PDF_HEADER_LINES
+ )
+ end
+ end
+
def write_minutes_footers
pdf.repeat lambda { |pg| header_footer_filter_pages.exclude?(pg) }, dynamic: true do
draw_minutes_footer_on_page
@@ -152,12 +173,12 @@ module Meetings::PDF::Minutes
text_style = styles.page_footer
pos_right = draw_text_right(footer_page_nr, text_style, top)
spacing = styles.page_footer_horizontal_spacing
- draw_text_multiline_left(
+ draw_footer_text_multiline_left(
text: footer_minutes,
text_style:,
available_width: pdf.bounds.width - spacing - pos_right,
top:,
- max_lines: :MAX_NR_OF_PDF_FOOTER_LINES
+ max_lines: MAX_NR_OF_PDF_FOOTER_LINES
)
end
diff --git a/modules/meeting/app/workers/meetings/pdf/minutes/schema.json b/modules/meeting/app/workers/meetings/pdf/minutes/schema.json
index ca242824c32..fbb4e88c05d 100644
--- a/modules/meeting/app/workers/meetings/pdf/minutes/schema.json
+++ b/modules/meeting/app/workers/meetings/pdf/minutes/schema.json
@@ -1,6 +1,6 @@
{
"type": "object",
- "title": "Meetings PDF",
+ "title": "Meeting Minutes PDF",
"properties": {
"page": {
"$ref": "#/$defs/page"
@@ -700,6 +700,7 @@
"page_header": {
"align": "left",
"offset": 20,
+ "width": 400,
"size": 8
}
},
@@ -707,6 +708,13 @@
"align": {
"$ref": "#/$defs/alignment"
},
+ "width": {
+ "title": "The maximum width of the page header text",
+ "examples": [
+ 400
+ ],
+ "$ref": "#/$defs/measurement"
+ },
"offset": {
"title": "Offset position from page top",
"examples": [
diff --git a/modules/meeting/app/workers/meetings/pdf/minutes/standard.yml b/modules/meeting/app/workers/meetings/pdf/minutes/standard.yml
index d65a06e7a4b..d797842dda7 100644
--- a/modules/meeting/app/workers/meetings/pdf/minutes/standard.yml
+++ b/modules/meeting/app/workers/meetings/pdf/minutes/standard.yml
@@ -8,8 +8,9 @@ page:
link_color: "175A8E"
page_header:
- offset: 20
- size: 8
+ offset: 30
+ width: 200
+ size: 12
page_footer:
offset: -30
@@ -18,7 +19,7 @@ page_footer:
page_logo:
height: 43
- offset: 25
+ offset: 11
align: "right"
page_heading:
diff --git a/modules/meeting/config/locales/en.yml b/modules/meeting/config/locales/en.yml
index 449683b4045..caaa032c9c6 100644
--- a/modules/meeting/config/locales/en.yml
+++ b/modules/meeting/config/locales/en.yml
@@ -277,6 +277,9 @@ en:
minutes:
label: Minutes
caption: The minutes template is suitable for meetings that have been closed and are archived.
+ page_header_left:
+ label: Page header left
+ caption: This text will appear on every page at the left of the header on the first page.
author:
label: Author
caption: The author of the minutes will be displayed in the subtitle.