starred/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2026-02-05 00:29:48 +03:00
Code Issues 304 Packages Projects Releases 10 Wiki Activity

[FEATURE] Header/Footer for PDF Export #418

New Issue
Open
opened 2026-02-04 19:44:22 +03:00 by OVERLORD · 21 comments
OVERLORD commented 2026-02-04 19:44:22 +03:00
Owner
Copy Link

Originally created by @sirup on GitHub (Aug 31, 2017).

For Feature Requests

For PDF etc. Export it would be nice to set a global Header/Footer to identify where the file is from etc. Maybe also wih Dynamic Fields like Version / Date / Creator.

Originally created by @sirup on GitHub (Aug 31, 2017). ### For Feature Requests For PDF etc. Export it would be nice to set a global Header/Footer to identify where the file is from etc. Maybe also wih Dynamic Fields like Version / Date / Creator.
OVERLORD added the 🔨 Feature Request label 2026-02-04 19:44:22 +03:00
OVERLORD commented 2026-02-04 19:44:25 +03:00
Author
Owner
Copy Link

@Chris-ZA commented on GitHub (Sep 29, 2017):

I would support this request. I was thinking about this the other day when I exported a book.

Our current Microsoft Word document template have this and it helps a lot to have this information on a PDF or printed document.

@Chris-ZA commented on GitHub (Sep 29, 2017): I would support this request. I was thinking about this the other day when I exported a book. Our current Microsoft Word document template have this and it helps a lot to have this information on a PDF or printed document.
OVERLORD commented 2026-02-04 19:44:31 +03:00
Author
Owner
Copy Link

@aljawaid commented on GitHub (Oct 6, 2017):

This would be ideal. Shame we can't currently add the logo or other bits and have the option to remove the 'last edited by' information. Page numbers and a possible optional front cover page would be good too.

@aljawaid commented on GitHub (Oct 6, 2017): This would be ideal. Shame we can't currently add the logo or other bits and have the option to remove the 'last edited by' information. Page numbers and a possible optional front cover page would be good too.
OVERLORD commented 2026-02-04 19:44:38 +03:00
Author
Owner
Copy Link

@p0lp0 commented on GitHub (Nov 10, 2017):

Agree, good request.

@p0lp0 commented on GitHub (Nov 10, 2017): Agree, good request.
OVERLORD commented 2026-02-04 19:44:48 +03:00
Author
Owner
Copy Link

@Ady-Gould commented on GitHub (Jan 14, 2018):

I also support this feature.

The feature should have items such as:

  • page numbers
  • chapter title/number
  • book title
  • draft (when not finalised)
  • logo
  • date/time
  • author/editors/etc
@Ady-Gould commented on GitHub (Jan 14, 2018): I also support this feature. The feature should have items such as: - page numbers - chapter title/number - book title - draft (when not finalised) - logo - date/time - author/editors/etc
OVERLORD commented 2026-02-04 19:44:56 +03:00
Author
Owner
Copy Link

@badsmoke commented on GitHub (Aug 10, 2020):

is there any news on this topic?

@badsmoke commented on GitHub (Aug 10, 2020): is there any news on this topic?
OVERLORD commented 2026-02-04 19:45:11 +03:00
Author
Owner
Copy Link

@injektion commented on GitHub (Sep 11, 2020):

Hey @ssddanbrown - I've pushed a branch ( https://github.com/injektion/BookStack/tree/exportheaders ) which might help with this... For exports, it'll display a page number in the footer and allow users to create a page to include as a header on every page.

Most of the juice is in partials/export-header-footer.blade.php which is now included in all the /views/[books|chapters|pages]/export.blade.php and checks for a couple .env variables

EXPORT_HEADER_PAGE_SLUG=header
EXPORT_SHOW_PAGE_NUMBERS=true

There's some extra CSS added to partials/export-styles.blade.php which sets up a counter for pages, and if the .env is true will drop it into a footer div

        .pagenum:before {
            content: counter(page);
        }

As for the header, I'm currently letting the user define a page as their header, and then in partials/export-header-footer.blade.php using the slug of that page to import a header....

@if(env("EXPORT_HEADER_PAGE_SLUG"))
<div class="header">
    @php
        $PAGE = new \BookStack\Entities\Page();
        $page = $PAGE::where("slug", "=", env("EXPORT_HEADER_PAGE_SLUG"))->first();
        $page->html = (new \BookStack\Entities\Managers\PageContent($page))->render();
    @endphp
    {!! $page->html !!}
</div>
@endif

It's working fine to allow the user to create their own headers, add some page numbering, and export, but I think there's probably a better flow to how to get the user to define the page to use as their header... Do you have any recommendations on where you'd like to see the header get defined, or do you think this will work for those who want it?

@injektion commented on GitHub (Sep 11, 2020): Hey @ssddanbrown - I've pushed a branch ( [https://github.com/injektion/BookStack/tree/exportheaders](https://github.com/injektion/BookStack/tree/exportheaders) ) which might help with this... For exports, it'll display a page number in the footer and allow users to create a page to include as a header on every page. Most of the juice is in [partials/export-header-footer.blade.php](https://github.com/injektion/BookStack/blob/exportheaders/resources/views/partials/export-header-footer.blade.php) which is now included in all the /views/[books|chapters|pages]/export.blade.php and checks for a couple .env variables ``` EXPORT_HEADER_PAGE_SLUG=header EXPORT_SHOW_PAGE_NUMBERS=true ``` There's some extra CSS added to partials/export-styles.blade.php which sets up a counter for pages, and if the .env is true will drop it into a footer div ``` .pagenum:before { content: counter(page); } ``` As for the header, I'm currently letting the user define a page as their header, and then in [partials/export-header-footer.blade.php](https://github.com/injektion/BookStack/blob/exportheaders/resources/views/partials/export-header-footer.blade.php) using the slug of that page to import a header.... ``` @if(env("EXPORT_HEADER_PAGE_SLUG")) <div class="header"> @php $PAGE = new \BookStack\Entities\Page(); $page = $PAGE::where("slug", "=", env("EXPORT_HEADER_PAGE_SLUG"))->first(); $page->html = (new \BookStack\Entities\Managers\PageContent($page))->render(); @endphp {!! $page->html !!} </div> @endif ``` It's working fine to allow the user to create their own headers, add some page numbering, and export, but I think there's probably a better flow to how to get the user to define the page to use as their header... Do you have any recommendations on where you'd like to see the header get defined, or do you think this will work for those who want it?
OVERLORD commented 2026-02-04 19:45:21 +03:00
Author
Owner
Copy Link

@lenusch commented on GitHub (Sep 11, 2020):

Hey @ssddanbrown - I've pushed a branch ( https://github.com/injektion/BookStack/tree/exportheaders ) which might help with this... For exports, it'll display a page number in the footer and allow users to create a page to include as a header on every page.

can i with this disable Footer informations in PDF? I don't want author etc. inside of Footer.

@lenusch commented on GitHub (Sep 11, 2020): > Hey @ssddanbrown - I've pushed a branch ( https://github.com/injektion/BookStack/tree/exportheaders ) which might help with this... For exports, it'll display a page number in the footer and allow users to create a page to include as a header on every page. can i with this disable Footer informations in PDF? I don't want author etc. inside of Footer.
OVERLORD commented 2026-02-04 19:45:38 +03:00
Author
Owner
Copy Link

@joaovitorteixeira commented on GitHub (Dec 7, 2021):

Hey @ssddanbrown, is there any new about this feature?

@joaovitorteixeira commented on GitHub (Dec 7, 2021): Hey @ssddanbrown, is there any new about this feature?
OVERLORD commented 2026-02-04 19:45:57 +03:00
Author
Owner
Copy Link

@emilbasv3 commented on GitHub (Mar 25, 2022):

Any news on this? It would be much appreciated!

@emilbasv3 commented on GitHub (Mar 25, 2022): Any news on this? It would be much appreciated!
OVERLORD commented 2026-02-04 19:46:02 +03:00
Author
Owner
Copy Link

@cervantesl commented on GitHub (Apr 11, 2022):

Any news on this?

I also support this feature.

Thx.

@cervantesl commented on GitHub (Apr 11, 2022): Any news on this? I also support this feature. Thx.
OVERLORD commented 2026-02-04 19:46:10 +03:00
Author
Owner
Copy Link

@ssddanbrown commented on GitHub (Apr 11, 2022):

There is no news on this upon any additional context within #2311. If there was you'd likely see something here.

The only difference since that PR is that we're now probably more DOMPDF focused rather than WKHTMLtoPDF.
Like mentioned in that PR, the visual theme system could likely be used to achieve this, although it may be worth us making template changes to better accommodate this specific feature.

@ssddanbrown commented on GitHub (Apr 11, 2022): There is no news on this upon any additional context within #2311. If there was you'd likely see something here. The only difference since that PR is that we're now probably more DOMPDF focused rather than WKHTMLtoPDF. Like mentioned in that PR, the [visual theme system](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/visual-theme-system.md) could likely be used to achieve this, although it may be worth us making template changes to better accommodate this specific feature.
OVERLORD commented 2026-02-04 19:46:15 +03:00
Author
Owner
Copy Link

@ssddanbrown commented on GitHub (Aug 14, 2022):

If it helps, I just published a video on using the visual theme system to achieve a footer on PDF exports with the default DomPDF renderer:
https://youtu.be/5bZ7zlNEphc

@ssddanbrown commented on GitHub (Aug 14, 2022): If it helps, I just published a video on using the visual theme system to achieve a footer on PDF exports with the default DomPDF renderer: https://youtu.be/5bZ7zlNEphc
OVERLORD commented 2026-02-04 19:46:19 +03:00
Author
Owner
Copy Link

@ADMDW commented on GitHub (Mar 25, 2023):

Your video is very helpful - thank you.
How can the book title, chapter, and page name be added in addition to the page number?
Thanks.

@ADMDW commented on GitHub (Mar 25, 2023): Your video is very helpful - thank you. How can the book title, chapter, and page name be added in addition to the page number? Thanks.
OVERLORD commented 2026-02-04 19:46:27 +03:00
Author
Owner
Copy Link

@ADMDW commented on GitHub (Mar 26, 2023):

I have found the following after some experimentation:

<div style="float: right; text-align:right; max-width: 530px; font-size:11px;">
	@if(isset($page))
		{{ $page->book->name }}
		<br>
		<i>{{ $page->name }}</i>
	@else
		{{ $book->name }}
	@endif
</div>

When I export only one page, both the book title and the page title are displayed, and when I export the entire book, only the book title is displayed. This works for my needs.

@ADMDW commented on GitHub (Mar 26, 2023): I have found the following after some experimentation: ``` <div style="float: right; text-align:right; max-width: 530px; font-size:11px;"> @if(isset($page)) {{ $page->book->name }} <br> <i>{{ $page->name }}</i> @else {{ $book->name }} @endif </div> ``` When I export only one page, both the book title and the page title are displayed, and when I export the entire book, only the book title is displayed. This works for my needs.
OVERLORD commented 2026-02-04 19:46:30 +03:00
Author
Owner
Copy Link

@ADMDW commented on GitHub (Mar 26, 2023):

This is the whole content of my /var/www/bookstack/themes/myTemplate/layouts/parts/export-body-start.blade.php file:

{{-- This is a placeholder template file provided as a --}}
{{-- convenience to users of the visual theme system. --}}

@if ($format === 'pdf')
  <style media="print">
    .print-header-footer {
      position: fixed;
      width: 100%;
    }
    .print-footer {
      position: fixed;
      width: 100%;
      bottom: -40px;
    }
    .print-header-footer-inner {
      max-width: 840px;
      margin: 0px;
      color: #666;
    }
    .print-page-number:after {
      content: "Seite " counter(page);
    }
    @page {
      margin-top: 110px;
      margin-bottom: 60px;
    }
</style>

<!-- Header -->
<div class="print-header-footer" style="top: -90px;">
	<div class="print-header-footer-inner">
		<div style="float: left; margin:-5px;">
			<img height="48px" src="data:image/png;base64,{{ base64_encode(file_get_contents(theme_path('DWLogo.png'))) }}">
		</div>
		<div style="float: right; text-align:right; max-width: 530px; font-size:11px;">
			@if(isset($page))
    		{{ $page->book->name }}
			<br>
			{{ $page->name }}
			@else
 			{{ $book->name }}
			@endif
		</div>
	</div>
	<div style="clear:both;"></div>
<hr>
</div>
<!-- /Header -->
<!-- Footer -->
<div class="print-header-footer" style="bottom: -40px;">
<hr>
	<div class="print-header-footer-inner">
		<div style="float: left;">
			<!-- ggf. Text unten links -->
		</div>
		<div style="float: right;">
			<div class="print-page-number"></div>
		</div>
	</div>
	<div style="clear:both;"></div>
</div>
<!-- /Footer -->
@endif

To make the function work, add the own template in the /var/www/bookstack/.env file:

APP_THEME=myTemplate

@ADMDW commented on GitHub (Mar 26, 2023): This is the whole content of my /var/www/bookstack/themes/myTemplate/layouts/parts/export-body-start.blade.php file: ``` {{-- This is a placeholder template file provided as a --}} {{-- convenience to users of the visual theme system. --}} @if ($format === 'pdf') <style media="print"> .print-header-footer { position: fixed; width: 100%; } .print-footer { position: fixed; width: 100%; bottom: -40px; } .print-header-footer-inner { max-width: 840px; margin: 0px; color: #666; } .print-page-number:after { content: "Seite " counter(page); } @page { margin-top: 110px; margin-bottom: 60px; } </style> <!-- Header --> <div class="print-header-footer" style="top: -90px;"> <div class="print-header-footer-inner"> <div style="float: left; margin:-5px;"> <img height="48px" src="data:image/png;base64,{{ base64_encode(file_get_contents(theme_path('DWLogo.png'))) }}"> </div> <div style="float: right; text-align:right; max-width: 530px; font-size:11px;"> @if(isset($page)) {{ $page->book->name }} <br> {{ $page->name }} @else {{ $book->name }} @endif </div> </div> <div style="clear:both;"></div> <hr> </div> <!-- /Header --> <!-- Footer --> <div class="print-header-footer" style="bottom: -40px;"> <hr> <div class="print-header-footer-inner"> <div style="float: left;"> <!-- ggf. Text unten links --> </div> <div style="float: right;"> <div class="print-page-number"></div> </div> </div> <div style="clear:both;"></div> </div> <!-- /Footer --> @endif ``` To make the function work, add the own template in the /var/www/bookstack/.env file: `APP_THEME=myTemplate`
OVERLORD commented 2026-02-04 19:46:43 +03:00
Author
Owner
Copy Link

@SuperPat45 commented on GitHub (Jun 28, 2023):

I know a JavaScript library named paged.js https://pagedjs.org/documentation/ which allow complex headers, footers with page numbers, table of content with page number...
I use it to generate a full PDF book (1500 pages) in one of my project with node.js + puppeteer module + chromium

@SuperPat45 commented on GitHub (Jun 28, 2023): I know a JavaScript library named paged.js https://pagedjs.org/documentation/ which allow complex headers, footers with page numbers, table of content with page number... I use it to generate a full PDF book (1500 pages) in one of my project with node.js + puppeteer module + chromium
OVERLORD commented 2026-02-04 19:46:51 +03:00
Author
Owner
Copy Link

@SLongus commented on GitHub (Sep 22, 2023):

This Request is opened since 2017. We try BookStack for as our Documentacion system, but without this function it's not functional for us. The Work Around in the youtube video is very nice, but what are the problems when updating to a new version? That looks like it could be problematic...

@SLongus commented on GitHub (Sep 22, 2023): This Request is opened since 2017. We try BookStack for as our Documentacion system, but without this function it's not functional for us. The Work Around in the youtube video is very nice, but what are the problems when updating to a new version? That looks like it could be problematic...
OVERLORD commented 2026-02-04 19:47:01 +03:00
Author
Owner
Copy Link

@mitchell-accipio commented on GitHub (Nov 2, 2023):

We are also using Bookstack as our Documentation system and we use WKHTMLtoPDF for PDF exports thanks to the superior exporting aesthetics; I have seen This Issue That could potentially solve some of the layout issues on DomPDF for us, but branding would be incredibly useful since we want to be able to export policies to provide to customers as part of tender, for example.

In my opinion Export Branding would provide a great enhancement of features that would make Bookstack more usable as a business solution.

I will take solutions in this issue and other relevant issues into consideration but would love to highlight this feature as something my organisation could really use.

@mitchell-accipio commented on GitHub (Nov 2, 2023): We are also using Bookstack as our Documentation system and we use WKHTMLtoPDF for PDF exports thanks to the superior exporting aesthetics; I have seen [This Issue]( https://github.com/BookStackApp/BookStack/issues/2646 ) That could potentially solve some of the layout issues on DomPDF for us, but branding would be incredibly useful since we want to be able to export policies to provide to customers as part of tender, for example. In my opinion Export Branding would provide a great enhancement of features that would make Bookstack more usable as a business solution. I will take solutions in this issue and other relevant issues into consideration but would love to highlight this feature as something my organisation could really use.
OVERLORD commented 2026-02-04 19:47:07 +03:00
Author
Owner
Copy Link

@Koruyo commented on GitHub (Nov 17, 2023):

For our uses, PDF export would need an index with page numbers, and page headers and or footers with current page/numberofpages e.g. Page 5/200

Sadly i cant find any solution to make bookstack work for us.

While one can hack in simple page numbers in a header or footer (following the youtube video of bookstack about this), it remains sub-optimal for printed documentations not having an index with page numbers and the maximum number of pages to make sure the document is complete/stays/stayed complete.
I really like bookstack, i hope some day i can finally make it work for us... (every few years i check sadly it still remains open)

@Koruyo commented on GitHub (Nov 17, 2023): For our uses, PDF export would need an index with page numbers, and page headers and or footers with current page/numberofpages e.g. Page 5/200 Sadly i cant find any solution to make bookstack work for us. While one can hack in simple page numbers in a header or footer (following the youtube video of bookstack about this), it remains sub-optimal for printed documentations not having an index with page numbers and the maximum number of pages to make sure the document is complete/stays/stayed complete. I really like bookstack, i hope some day i can finally make it work for us... (every few years i check sadly it still remains open)
OVERLORD commented 2026-02-04 19:47:12 +03:00
Author
Owner
Copy Link

@SLongus commented on GitHub (Feb 9, 2024):

Any news on this feature? This would be so important =(

@SLongus commented on GitHub (Feb 9, 2024): Any news on this feature? This would be so important =(
OVERLORD commented 2026-02-04 19:47:21 +03:00
Author
Owner
Copy Link

@lxwulf commented on GitHub (Nov 3, 2024):

I would also like to know how it's going with this issue or better say feature request…

@lxwulf commented on GitHub (Nov 3, 2024): I would also like to know how it's going with this issue or better say feature request…
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
🎨 Design
📖 Docs Update
🐛 Bug
🐛 Bug
:cat2:🐈 Possible duplicate
💿 Database
☕ Open to discussion
💻 Front-End
🐕 Support
🚪 Authentication
🌍 Translations
🔌 API Task
🏭 Back-End
⛲ Upstream
🔨 Feature Request
🛠️ Enhancement
🛠️ Enhancement
🛠️ Enhancement
❤️ Happy feedback
🔒 Security
🔍 Pending Validation
💆 UX
📝 WYSIWYG Editor
🌔 Out of scope
🔩 API Request
:octocat: Admin/Meta
🖌️ View Customization
❓ Question
🚀 Priority
🛡️ Blocked
🚚 Export System
♿ A11y
🔧 Maintenance
> Markdown Editor
No Label 🔨 Feature Request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
OVERLORD
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#418
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?