Compare commits

...

5 Commits

Author SHA1 Message Date
Malo
1bfec7b78f
Merge ccabbe5bec4ea62fb05747154b0027f70ab3c811 into 9a6268050fb769e18c4889fa5f59d4150e8878d6 2025-07-15 21:42:47 +02:00
Laurenz
9a6268050f
HTML frame improvements (#6605) 2025-07-15 14:48:31 +00:00
Malo
ccabbe5bec Add test 2025-07-12 14:30:29 +01:00
Malo
b374aa131b Update tests 2025-07-12 14:20:11 +01:00
Malo
c69c07fab5 Fix HTML smartquotes 2025-07-12 14:20:02 +01:00
10 changed files with 126 additions and 32 deletions

View File

@ -1,3 +1,5 @@
use crate::fragment::html_fragment;
use crate::{attr, tag, FrameElem, HtmlElem, HtmlElement, HtmlFrame, HtmlNode};
use typst_library::diag::{warning, SourceResult}; use typst_library::diag::{warning, SourceResult};
use typst_library::engine::Engine; use typst_library::engine::Engine;
use typst_library::foundations::{Content, StyleChain, Target, TargetElem}; use typst_library::foundations::{Content, StyleChain, Target, TargetElem};
@ -5,10 +7,10 @@ use typst_library::introspection::{SplitLocator, TagElem};
use typst_library::layout::{Abs, Axes, BlockBody, BlockElem, BoxElem, Region, Size}; use typst_library::layout::{Abs, Axes, BlockBody, BlockElem, BoxElem, Region, Size};
use typst_library::model::ParElem; use typst_library::model::ParElem;
use typst_library::routines::Pair; use typst_library::routines::Pair;
use typst_library::text::{LinebreakElem, SmartQuoteElem, SpaceElem, TextElem}; use typst_library::text::{
is_default_ignorable, LinebreakElem, SmartQuoteElem, SmartQuoter, SmartQuotes,
use crate::fragment::html_fragment; SpaceElem, TextElem,
use crate::{attr, tag, FrameElem, HtmlElem, HtmlElement, HtmlFrame, HtmlNode}; };
/// Converts realized content into HTML nodes. /// Converts realized content into HTML nodes.
pub fn convert_to_nodes<'a>( pub fn convert_to_nodes<'a>(
@ -16,9 +18,10 @@ pub fn convert_to_nodes<'a>(
locator: &mut SplitLocator, locator: &mut SplitLocator,
children: impl IntoIterator<Item = Pair<'a>>, children: impl IntoIterator<Item = Pair<'a>>,
) -> SourceResult<Vec<HtmlNode>> { ) -> SourceResult<Vec<HtmlNode>> {
let mut quoter = SmartQuoter::new();
let mut output = Vec::new(); let mut output = Vec::new();
for (child, styles) in children { for (child, styles) in children {
handle(engine, child, locator, styles, &mut output)?; handle(engine, child, locator, styles, &mut quoter, &mut output)?;
} }
Ok(output) Ok(output)
} }
@ -29,6 +32,7 @@ fn handle(
child: &Content, child: &Content,
locator: &mut SplitLocator, locator: &mut SplitLocator,
styles: StyleChain, styles: StyleChain,
quoter: &mut SmartQuoter,
output: &mut Vec<HtmlNode>, output: &mut Vec<HtmlNode>,
) -> SourceResult<()> { ) -> SourceResult<()> {
if let Some(elem) = child.to_packed::<TagElem>() { if let Some(elem) = child.to_packed::<TagElem>() {
@ -95,10 +99,20 @@ fn handle(
} else if let Some(elem) = child.to_packed::<LinebreakElem>() { } else if let Some(elem) = child.to_packed::<LinebreakElem>() {
output.push(HtmlElement::new(tag::br).spanned(elem.span()).into()); output.push(HtmlElement::new(tag::br).spanned(elem.span()).into());
} else if let Some(elem) = child.to_packed::<SmartQuoteElem>() { } else if let Some(elem) = child.to_packed::<SmartQuoteElem>() {
output.push(HtmlNode::text( let double = elem.double.get(styles);
if elem.double.get(styles) { '"' } else { '\'' }, if elem.enabled.get(styles) {
child.span(), let before = last_char(output);
)); let quotes = SmartQuotes::get(
elem.quotes.get_ref(styles),
styles.get(TextElem::lang),
styles.get(TextElem::region),
elem.alternative.get(styles),
);
let quote = quoter.quote(before, &quotes, double);
output.push(HtmlNode::text(quote, child.span()));
} else {
output.push(HtmlNode::text(if double { '"' } else { '\'' }, child.span()));
}
} else if let Some(elem) = child.to_packed::<FrameElem>() { } else if let Some(elem) = child.to_packed::<FrameElem>() {
let locator = locator.next(&elem.span()); let locator = locator.next(&elem.span());
let style = TargetElem::target.set(Target::Paged).wrap(); let style = TargetElem::target.set(Target::Paged).wrap();
@ -109,10 +123,7 @@ fn handle(
styles.chain(&style), styles.chain(&style),
Region::new(Size::splat(Abs::inf()), Axes::splat(false)), Region::new(Size::splat(Abs::inf()), Axes::splat(false)),
)?; )?;
output.push(HtmlNode::Frame(HtmlFrame { output.push(HtmlNode::Frame(HtmlFrame::new(frame, styles)));
inner: frame,
text_size: styles.resolve(TextElem::size),
}));
} else { } else {
engine.sink.warn(warning!( engine.sink.warn(warning!(
child.span(), child.span(),
@ -123,6 +134,20 @@ fn handle(
Ok(()) Ok(())
} }
/// Returns the last non-default ignorable character from the passed nodes.
fn last_char(nodes: &[HtmlNode]) -> Option<char> {
for node in nodes.iter().rev() {
if let Some(c) = match node {
HtmlNode::Text(s, _) => s.chars().rev().find(|&c| !is_default_ignorable(c)),
HtmlNode::Element(e) => last_char(&e.children),
_ => None,
} {
return Some(c);
}
}
None
}
/// Checks whether the given element is an inline-level HTML element. /// Checks whether the given element is an inline-level HTML element.
pub fn is_inline(elem: &Content) -> bool { pub fn is_inline(elem: &Content) -> bool {
elem.to_packed::<HtmlElem>() elem.to_packed::<HtmlElem>()

View File

@ -2,10 +2,11 @@ use std::fmt::{self, Debug, Display, Formatter};
use ecow::{EcoString, EcoVec}; use ecow::{EcoString, EcoVec};
use typst_library::diag::{bail, HintedStrResult, StrResult}; 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::introspection::{Introspector, Tag};
use typst_library::layout::{Abs, Frame}; use typst_library::layout::{Abs, Frame};
use typst_library::model::DocumentInfo; use typst_library::model::DocumentInfo;
use typst_library::text::TextElem;
use typst_syntax::Span; use typst_syntax::Span;
use typst_utils::{PicoStr, ResolvedPicoStr}; use typst_utils::{PicoStr, ResolvedPicoStr};
@ -279,3 +280,10 @@ pub struct HtmlFrame {
/// consistently. /// consistently.
pub text_size: Abs, 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) let pretty_inside = allows_pretty_inside(element.tag)
&& element.children.iter().any(|node| match node { && element.children.iter().any(|node| match node {
HtmlNode::Element(child) => wants_pretty_around(child.tag), HtmlNode::Element(child) => wants_pretty_around(child.tag),
HtmlNode::Frame(_) => true,
_ => false, _ => false,
}); });
@ -305,14 +306,6 @@ fn write_escape(w: &mut Writer, c: char) -> StrResult<()> {
/// Encode a laid out frame into the writer. /// Encode a laid out frame into the writer.
fn write_frame(w: &mut Writer, frame: &HtmlFrame) { fn write_frame(w: &mut Writer, frame: &HtmlFrame) {
// FIXME: This string replacement is obviously a hack. let svg = typst_svg::svg_html_frame(&frame.inner, frame.text_size);
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,
),
);
w.buf.push_str(&svg); w.buf.push_str(&svg);
} }

View File

@ -45,6 +45,30 @@ pub fn svg_frame(frame: &Frame) -> String {
renderer.finalize() 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. /// Export a document with potentially multiple pages into a single SVG file.
/// ///
/// The padding will be added around and between the individual frames. /// The padding will be added around and between the individual frames.
@ -158,8 +182,13 @@ impl State {
impl SVGRenderer { impl SVGRenderer {
/// Create a new SVG renderer with empty glyph and clip path. /// Create a new SVG renderer with empty glyph and clip path.
fn new() -> Self { 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 { SVGRenderer {
xml: XmlWriter::new(xmlwriter::Options::default()), xml: XmlWriter::new(options),
glyphs: Deduplicator::new('g'), glyphs: Deduplicator::new('g'),
clip_paths: Deduplicator::new('c'), clip_paths: Deduplicator::new('c'),
gradient_refs: Deduplicator::new('g'), gradient_refs: Deduplicator::new('g'),
@ -170,11 +199,22 @@ impl SVGRenderer {
} }
} }
/// Write the SVG header, including the `viewBox` and `width` and `height` /// Write the default SVG header, including a `typst-doc` class, the
/// attributes. /// `viewBox` and `width` and `height` attributes.
fn write_header(&mut self, size: Size) { 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.start_element("svg");
self.xml.write_attribute("class", "typst-doc"); write_custom_attrs(&mut self.xml);
self.xml.write_attribute_fmt( self.xml.write_attribute_fmt(
"viewBox", "viewBox",
format_args!("0 0 {} {}", size.x.to_pt(), size.y.to_pt()), 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

@ -6,8 +6,8 @@
</head> </head>
<body> <body>
<h2>Heading is no paragraph</h2> <h2>Heading is no paragraph</h2>
<p>I'm a paragraph.</p> <p>Im a paragraph.</p>
<div>I'm not.</div> <div>Im not.</div>
<div> <div>
<p>We are two.</p> <p>We are two.</p>
<p>So we are paragraphs.</p> <p>So we are paragraphs.</p>

View File

@ -5,6 +5,6 @@
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
</head> </head>
<body> <body>
<p>When you said that “he surely meant that she intended to say “I'm sorry””, I was quite confused.</p> <p>When you said that “he surely meant that she intended to say “Im sorry””, I was quite confused.</p>
</body> </body>
</html> </html>

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>When you said that “he surely meant that she intended to say “Im sorry””, I was quite confused.</p>
<p><span style="display: inline-block;">box</span></p>
</body>
</html>

View File

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

View File

@ -172,3 +172,8 @@ Some people's thought on this would be #[#set smartquote(enabled: false); "stran
--- issue-5146-smartquotes-after-equations --- --- issue-5146-smartquotes-after-equations ---
$i$'s $i$ 's $i$'s $i$ 's
--- smartquotes-html html ---
When you said that "he surely meant that 'she intended to say "I'm sorry"'", I was quite confused.
'#box[box]'