Compare commits

...

13 Commits

Author SHA1 Message Date
diquah
6dbd8adb57
Merge 4aa6dcf578ce3fde6209369c358bde012150146c into 9a6268050fb769e18c4889fa5f59d4150e8878d6 2025-07-15 13:55:52 -07:00
Laurenz
9a6268050f
HTML frame improvements (#6605) 2025-07-15 14:48:31 +00:00
diquah
4aa6dcf578
Merge branch 'main' into main 2025-05-02 18:53:25 -07:00
diquah
34e2e43445 Minor formatting fix 2025-05-02 17:09:18 -07:00
diquah
0148a5913d Merge branch 'main' of https://github.com/diquah/typst 2025-05-02 16:58:49 -07:00
diquah
c8d45148f1 Fix naming convention 2025-05-02 16:58:45 -07:00
diquah
a445a3108f
Merge branch 'main' into main 2025-04-11 12:24:55 -07:00
diquah
69d0d9e26d Formatting fix 2025-04-10 19:23:21 -07:00
diquah
4fa7e5cfd9 Fix warnings 2025-04-10 19:18:21 -07:00
diquah
7d6d46c4d8 Remove microjustification 2025-04-10 19:05:30 -07:00
diquah
07ba1c1636 Add microtype options for par 2025-04-10 19:01:02 -07:00
diquah
422eb36f16 Fix formatting issue 2025-04-10 00:15:44 -07:00
diquah
7f9adfac22 Add microjustification 2025-04-09 23:20:46 -07:00
8 changed files with 115 additions and 23 deletions

View File

@ -109,10 +109,7 @@ fn handle(
styles.chain(&style),
Region::new(Size::splat(Abs::inf()), Axes::splat(false)),
)?;
output.push(HtmlNode::Frame(HtmlFrame {
inner: frame,
text_size: styles.resolve(TextElem::size),
}));
output.push(HtmlNode::Frame(HtmlFrame::new(frame, styles)));
} else {
engine.sink.warn(warning!(
child.span(),

View File

@ -2,10 +2,11 @@ use std::fmt::{self, Debug, Display, Formatter};
use ecow::{EcoString, EcoVec};
use typst_library::diag::{bail, HintedStrResult, StrResult};
use typst_library::foundations::{cast, Dict, Repr, Str};
use typst_library::foundations::{cast, Dict, Repr, Str, StyleChain};
use typst_library::introspection::{Introspector, Tag};
use typst_library::layout::{Abs, Frame};
use typst_library::model::DocumentInfo;
use typst_library::text::TextElem;
use typst_syntax::Span;
use typst_utils::{PicoStr, ResolvedPicoStr};
@ -279,3 +280,10 @@ pub struct HtmlFrame {
/// consistently.
pub text_size: Abs,
}
impl HtmlFrame {
/// Wraps a laid-out frame.
pub fn new(inner: Frame, styles: StyleChain) -> Self {
Self { inner, text_size: styles.resolve(TextElem::size) }
}
}

View File

@ -121,6 +121,7 @@ fn write_children(w: &mut Writer, element: &HtmlElement) -> SourceResult<()> {
let pretty_inside = allows_pretty_inside(element.tag)
&& element.children.iter().any(|node| match node {
HtmlNode::Element(child) => wants_pretty_around(child.tag),
HtmlNode::Frame(_) => true,
_ => false,
});
@ -305,14 +306,6 @@ fn write_escape(w: &mut Writer, c: char) -> StrResult<()> {
/// Encode a laid out frame into the writer.
fn write_frame(w: &mut Writer, frame: &HtmlFrame) {
// FIXME: This string replacement is obviously a hack.
let svg = typst_svg::svg_frame(&frame.inner).replace(
"<svg class",
&format!(
"<svg style=\"overflow: visible; width: {}em; height: {}em;\" class",
frame.inner.width() / frame.text_size,
frame.inner.height() / frame.text_size,
),
);
let svg = typst_svg::svg_html_frame(&frame.inner, frame.text_size);
w.buf.push_str(&svg);
}

View File

@ -9,6 +9,7 @@ use ttf_parser::Tag;
use typst_library::engine::Engine;
use typst_library::foundations::{Smart, StyleChain};
use typst_library::layout::{Abs, Dir, Em, Frame, FrameItem, Point, Size};
use typst_library::model::{Microtype, ParElem};
use typst_library::text::{
families, features, is_default_ignorable, language, variant, Font, FontFamily,
FontVariant, Glyph, Lang, Region, ShiftSettings, TextEdgeBounds, TextElem, TextItem,
@ -144,7 +145,11 @@ impl ShapedGlyph {
|| self.c.is_ascii_digit()
}
pub fn base_adjustability(&self, style: CjkPunctStyle) -> Adjustability {
pub fn base_adjustability(
&self,
style: CjkPunctStyle,
microtype: Microtype,
) -> Adjustability {
let width = self.x_advance;
if self.is_space() {
Adjustability {
@ -168,7 +173,10 @@ impl ShapedGlyph {
shrinkability: (width / 4.0, width / 4.0),
}
} else {
Adjustability::default()
Adjustability {
stretchability: (Em::zero(), microtype.max_expand.em),
shrinkability: (Em::zero(), microtype.max_retract.em),
}
}
}
@ -1103,9 +1111,10 @@ fn track_and_space(ctx: &mut ShapingContext) {
/// and CJK punctuation adjustments according to Chinese Layout Requirements.
fn calculate_adjustability(ctx: &mut ShapingContext, lang: Lang, region: Option<Region>) {
let style = cjk_punct_style(lang, region);
let microtype = ParElem::microtype_in(ctx.styles);
for glyph in &mut ctx.glyphs {
glyph.adjustability = glyph.base_adjustability(style);
glyph.adjustability = glyph.base_adjustability(style, microtype);
}
let mut glyphs = ctx.glyphs.iter_mut().peekable();

View File

@ -136,6 +136,9 @@ pub struct ParElem {
#[default(false)]
pub justify: bool,
/// Microtypographical settings that are used during justification.
pub microtype: Microtype,
/// How to determine line breaks.
///
/// When this property is set to `{auto}`, its default value, optimized line
@ -224,6 +227,36 @@ impl ParElem {
type ParLine;
}
/// Configuration for microtypographical settings to be used during
/// justification.
#[derive(Debug, Default, Copy, Clone, PartialEq, Hash)]
pub struct Microtype {
/// How much a glyph is allowed to translate into its neighbor.
pub max_retract: Length,
/// How much a glyph is allowed to translate away from its neighbor.
pub max_expand: Length,
}
cast! {
Microtype,
self => Value::Dict(self.into()),
mut dict: Dict => {
let max_retract = dict.take("max-retract")?.cast()?;
let max_expand = dict.take("max-expand")?.cast()?;
dict.finish(&["max-retract", "max-expand"])?;
Self { max_retract, max_expand }
},
}
impl From<Microtype> for Dict {
fn from(microtype: Microtype) -> Self {
dict! {
"max-retract" => microtype.max_retract,
"max-expand" => microtype.max_expand,
}
}
}
/// How to determine line breaks in a paragraph.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Cast)]
pub enum Linebreaks {

View File

@ -45,6 +45,30 @@ pub fn svg_frame(frame: &Frame) -> String {
renderer.finalize()
}
/// Export a frame into an SVG suitable for embedding into HTML.
#[typst_macros::time(name = "svg html frame")]
pub fn svg_html_frame(frame: &Frame, text_size: Abs) -> String {
let mut renderer = SVGRenderer::with_options(xmlwriter::Options {
indent: xmlwriter::Indent::None,
..Default::default()
});
renderer.write_header_with_custom_attrs(frame.size(), |xml| {
xml.write_attribute("class", "typst-frame");
xml.write_attribute_fmt(
"style",
format_args!(
"overflow: visible; width: {}em; height: {}em;",
frame.width() / text_size,
frame.height() / text_size,
),
);
});
let state = State::new(frame.size(), Transform::identity());
renderer.render_frame(state, Transform::identity(), frame);
renderer.finalize()
}
/// Export a document with potentially multiple pages into a single SVG file.
///
/// The padding will be added around and between the individual frames.
@ -158,8 +182,13 @@ impl State {
impl SVGRenderer {
/// Create a new SVG renderer with empty glyph and clip path.
fn new() -> Self {
Self::with_options(Default::default())
}
/// Create a new SVG renderer with the given configuration.
fn with_options(options: xmlwriter::Options) -> Self {
SVGRenderer {
xml: XmlWriter::new(xmlwriter::Options::default()),
xml: XmlWriter::new(options),
glyphs: Deduplicator::new('g'),
clip_paths: Deduplicator::new('c'),
gradient_refs: Deduplicator::new('g'),
@ -170,11 +199,22 @@ impl SVGRenderer {
}
}
/// Write the SVG header, including the `viewBox` and `width` and `height`
/// attributes.
/// Write the default SVG header, including a `typst-doc` class, the
/// `viewBox` and `width` and `height` attributes.
fn write_header(&mut self, size: Size) {
self.write_header_with_custom_attrs(size, |xml| {
xml.write_attribute("class", "typst-doc");
});
}
/// Write the SVG header with additional attributes and standard attributes.
fn write_header_with_custom_attrs(
&mut self,
size: Size,
write_custom_attrs: impl FnOnce(&mut XmlWriter),
) {
self.xml.start_element("svg");
self.xml.write_attribute("class", "typst-doc");
write_custom_attrs(&mut self.xml);
self.xml.write_attribute_fmt(
"viewBox",
format_args!("0 0 {} {}", size.x.to_pt(), size.y.to_pt()),

View File

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<p>A rectangle:</p>
<svg class="typst-frame" style="overflow: visible; width: 4.5em; height: 3em;" viewBox="0 0 45 30" width="45pt" height="30pt" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:h5="http://www.w3.org/1999/xhtml"><g><g transform="translate(-0 -0)"><path class="typst-shape" fill="none" stroke="#000000" stroke-width="1" stroke-linecap="butt" stroke-linejoin="miter" stroke-miterlimit="4" d="M 0 0 L 0 30 L 45 30 L 45 0 Z "/></g></g></svg>
</body>
</html>

View File

@ -1,5 +1,6 @@
// No proper HTML tests here yet because we don't want to test SVG export just
// yet. We'll definitely add tests at some point.
--- html-frame html ---
A rectangle:
#html.frame(rect())
--- html-frame-in-layout ---
// Ensure that HTML frames are transparent in layout. This is less important for