CSS Print: Difference between revisions

From XPUB & Lens-Based wiki
No edit summary
Line 17: Line 17:
<small>Screenshot of one of the slides from Julie Blanc, as part of her presentation during the Paged.js workshop in October 2022. http://slides.julie-blanc.fr/20221013_xpub-rotterdam.html#/19</small>
<small>Screenshot of one of the slides from Julie Blanc, as part of her presentation during the Paged.js workshop in October 2022. http://slides.julie-blanc.fr/20221013_xpub-rotterdam.html#/19</small>


===CSS Paged Media module===
==CSS Paged Media module==


<blockquote>
<blockquote>
Line 31: Line 31:
===Not [yet] supported atm===
===Not [yet] supported atm===


====Modern browsers (no support yet)====
====Modern browsers (no CSS Print support yet)====


A few of the Paged Media CSS properties are supported by modern (aka up-to-date) browsers, but not many unfortunately, as the W3C CSS Paged Media module is still in a "working draft" mode.  
A few of the Paged Media CSS properties are supported by modern (aka up-to-date) browsers, but not many unfortunately, as the W3C CSS Paged Media module is still in a "working draft" mode.  
Line 39: Line 39:
It's good to say that you can still get pretty far with the properties that are supported atm. It really depends on what you want to make in the end.
It's good to say that you can still get pretty far with the properties that are supported atm. It really depends on what you want to make in the end.


====Paged.js and Weasyprint (already support)====
====Paged.js and Weasyprint (already support CSS Print!)====


If you nevertheless do want to use these properties, you can use '''Paged.js''', a Javascript library also known as a ''polyfill'', that aims to ''fill'' the gaps between the working draft document and modern browsers.  The project comes with extended documentation: https://pagedjs.org/documentation/.
If you nevertheless do want to use these properties, you can use '''Paged.js''', a Javascript library also known as a ''polyfill'', that aims to ''fill'' the gaps between the working draft document and modern browsers.  The project comes with extended documentation: https://pagedjs.org/documentation/.
Line 45: Line 45:
Or you can use '''Weasyprint''', who also supports most of the CSS Paged Media properties described on this page. In the  Weasyprint documentation [https://doc.courtbouillon.org/weasyprint/stable/api_reference.html#css-paged-media-module-level-3 here] you can read which properties are supported and which ones not.
Or you can use '''Weasyprint''', who also supports most of the CSS Paged Media properties described on this page. In the  Weasyprint documentation [https://doc.courtbouillon.org/weasyprint/stable/api_reference.html#css-paged-media-module-level-3 here] you can read which properties are supported and which ones not.


===@page rules===
==CSS Print examples==


* <code>@page</code>
An important proposal of the CSS Print drafts is to add a @page selector, that you can use to style a web page when it is rendered into pages.
** <code>size</code>
** <code>margin</code>
** <code>bleed</code> (not [yet] supported atm)
** <code>marks</code> (not [yet] supported atm)


<syntaxhighlight lang="css">
<syntaxhighlight lang="css">
Line 62: Line 58:
</syntaxhighlight>
</syntaxhighlight>


https://developer.mozilla.org/en-US/docs/Web/CSS/@page
More examples of CSS Print selectors and properties can be found here: [[CSS Print examples]]
 
https://pagedjs.org/documentation/5-web-design-for-print/#crop-and-cross-marks
 
=== @page selectors ===
 
* <code>@page :left</code>, <code>@page :right</code>
* <code>@page :first</code>
* <code>@page :blank</code>
* <code>@page :nth(1)</code> (not [yet] supported atm)
* <code>@page: groupname</code> + <code>@page groupname</code> (not [yet] supported atm)
 
<syntaxhighlight lang="css">
@page :first{
    background-color: MediumPurple;
}
@page :left{
    background-color: pink;
}
@page :right{
    background-color: yellow;
}
</syntaxhighlight>
 
https://developer.mozilla.org/en-US/docs/Web/CSS/@page
 
=== @page margin at-rules ===
 
* <code>@top-left{}</code> (not [yet] supported atm)
* <code>@left-bottom{}</code> (not [yet] supported atm)
* <code>@bottom-center{}</code> (not [yet] supported atm)
* etc.
 
<syntaxhighlight lang="css">
@page{
    @bottom-center{
        background-color: aqua;
        content: "This is a small note in the bottom margin."
    }
}
</syntaxhighlight>
 
https://developer.mozilla.org/en-US/docs/Web/CSS/@page#margin_at-rules
 
 
[[File:Margin-boxes.png|200px]]
 
<small>@page margin at-rules boxes, [https://pagedjs.org/images/margin-boxes.png image from Paged.js].</small>
 
===page breaks===
 
* <code>break-before</code>
* <code>break-after</code>
 
<syntaxhighlight lang="css">
h1 {
    break-after: always;
}
</syntaxhighlight>
 
https://devdocs.io/css/break-before
 
https://devdocs.io/css/break-after
 
=== running headers and footers ===
 
* <code>content()</code>, <code>string()</code> - named strings (not [yet] supported atm)
* <code>running()</code>, <code>element()</code> - running elements (not [yet] supported atm)
 
<syntaxhighlight lang="css">
@page{
    @top-center{
        background-color: lavendar;
        content: string(myTitle);
    }
}
h1{
    string-set: myTitle content(text);
}
</syntaxhighlight>
 
https://pagedjs.org/documentation/7-generated-content-in-margin-boxes/#named-string%3A-classical-running-headers%2Ffooters
 
===page counters===
 
* <code>counter()</code> (not [yet] supported atm)
 
<syntaxhighlight lang="css">
@page{
    @bottom-center{
        content: counter(page);
    }
}
</syntaxhighlight>
 
https://www.w3.org/TR/css-page-3/#page-based-counters
 
=== cross-referencing ===
 
* <code>target-counter()</code> (not [yet] supported atm)
* <code>target-text()</code> (not [yet] supported atm)
 
<syntaxhighlight lang="html">
<h1 id="maintitle">Protocols for an Active Archive (shownotes week 3)</h1>
 
<p>Some text that refer to the <a class="link" href="#maintitle">title</a>.</p>
</syntaxhighlight>
 
<syntaxhighlight lang="css">
.link::after {
  content: " (which is: " target-text(attr(href url)) ")";
}
</syntaxhighlight>
 
https://www.w3.org/TR/css-gcpm-3/#target-counter + https://pagedjs.org/documentation/-cross-references/#target-counter()
 
https://www.w3.org/TR/css-gcpm-3/#target-text + https://pagedjs.org/documentation/-cross-references/#target-text()


==CSS Print tools==
==CSS Print tools==

Revision as of 20:07, 2 December 2024

CSS

Cascading Style Sheets

body{
    background-color: pink;
    color: green;
    margin: 100px;
}

CSS1, CSS2.1, CSS3

Screenshot from 2023-10-03 15-11-04.png

Screenshot of one of the slides from Julie Blanc, as part of her presentation during the Paged.js workshop in October 2022. http://slides.julie-blanc.fr/20221013_xpub-rotterdam.html#/19

CSS Paged Media module

Paged media have many special requirements for the display of document content, which have evolved over the long history of printed books. Running headers and footers function as aids to navigation. Notes may appear at the bottom of the page, as footnotes. The properties of pages themselves may change based on their content or position in the document. Leaders visually connect related content. Cross-references may require generated text. Some paged media formats such as PDF use bookmarks for navigation.

This module defines new properties and values, so that authors may bring these techniques to paged media.

https://www.w3.org/TR/css-page-3/ (published working draft version)

https://drafts.csswg.org/css-page/ (current latest draft)

Not [yet] supported atm

Modern browsers (no CSS Print support yet)

A few of the Paged Media CSS properties are supported by modern (aka up-to-date) browsers, but not many unfortunately, as the W3C CSS Paged Media module is still in a "working draft" mode.

You can check if a CSS property is supported by a specific browser at: https://caniuse.com/

It's good to say that you can still get pretty far with the properties that are supported atm. It really depends on what you want to make in the end.

Paged.js and Weasyprint (already support CSS Print!)

If you nevertheless do want to use these properties, you can use Paged.js, a Javascript library also known as a polyfill, that aims to fill the gaps between the working draft document and modern browsers. The project comes with extended documentation: https://pagedjs.org/documentation/.

Or you can use Weasyprint, who also supports most of the CSS Paged Media properties described on this page. In the Weasyprint documentation here you can read which properties are supported and which ones not.

CSS Print examples

An important proposal of the CSS Print drafts is to add a @page selector, that you can use to style a web page when it is rendered into pages.

@page{
    size: A4 portrait;
    margin: 20mm 30mm;
    bleed: 3mm;
    marks: crop;
}

More examples of CSS Print selectors and properties can be found here: CSS Print examples

CSS Print tools

Layout engines for CSS Print

Custom workflows made with CSS Print

Books and publications made with CSS Print workflows

Examples, boilerplates, resources

Readings

Online channels

See also