ff3ed5c · typeable/pandoc

git.iko.soy/typeable/pandoc

FB2 writer: allow emphasis and notes in titles

Only and <empty-line /> are allowed in titles, but has the same type as an ordinary paragraphs. Therefore, there is no need to remove emphasis from titles. Also, don't intersperse paragraph with empty lines.

commitff3ed5c9f8ee985bb6026dd10b8c2549782c0296 authorAlexander Krotov <ilabdsf@gmail.com> dateWed 4 Apr 2018, 13:45 (9 years ago) parent2388be6

4 files changed+107−95

compare with master

unifiedsplit

src/Text/Pandoc/Writers/FB2.hs+4−6 test/fb2/titles.fb2+1−1 test/fb2/titles.markdown+1−1 test/writer.fb2+101−87

src/Text/Pandoc/Writers/FB2.hs+4−6

@@ -46,7 +46,7 @@ import Data.ByteString.Base64 (encode)

4646import qualified Data.ByteString.Char8 as B8

4747import Data.Char (isAscii, isControl, isSpace, toLower)

4848import Data.Either (lefts, rights)

49−import Data.List (intercalate, intersperse, isPrefixOf, stripPrefix)

49+import Data.List (intercalate, isPrefixOf, stripPrefix)

5050import Data.Text (Text, pack)

5151import Network.HTTP (urlEncode)

5252import Text.XML.Light

@@ -180,7 +180,7 @@ renderSection :: PandocMonad m => Int -> ([Inline], [Block]) -> FBM m Content

180180renderSection level (ttl, body) = do

181181 title <- if null ttl

182182 then return []

183− else return . list . el "title" . formatTitle $ ttl

183+ else list . el "title" <$> formatTitle ttl

184184 content <- if hasSubsections body

185185 then renderSections (level + 1) body

186186 else cMapM blockToXml body

@@ -189,11 +189,9 @@ renderSection level (ttl, body) = do

189189 hasSubsections = any isHeaderBlock

190190

191191-- | Only and <empty-line> are allowed within <title> in FB2.

192−formatTitle :: [Inline] -> [Content]

192+formatTitle :: PandocMonad m => [Inline] -> FBM m [Content]

193193formatTitle inlines =

194− let lns = split isLineBreak inlines

195− lns' = map (el "p" . cMap plain) lns

196− in intersperse (el "empty-line" ()) lns'

194+ cMapM (blockToXml . Para) $ split (== LineBreak) inlines

197195

198196split :: (a -> Bool) -> [a] -> [[a]]

199197split _ [] = []

test/fb2/titles.fb2+1−1

@@ -1,3 +1,3 @@

11<?xml version="1.0" encoding="UTF-8"?>

2−<FictionBook xmlns="http://www.gribuser.ru/xml/fictionbook/2.0" xmlns:l="http://www.w3.org/1999/xlink"><description><title-info><genre>unrecognised</genre></title-info><document-info><program-used>pandoc</program-used></document-info></description><body><title></title><section><title>Simple title</title>This example tests if Pandoc doesn’t insert forbidden elements in FictionBook titles.</section><section><title>Emphasized Strong Title</title></section></body></FictionBook>

2+<FictionBook xmlns="http://www.gribuser.ru/xml/fictionbook/2.0" xmlns:l="http://www.w3.org/1999/xlink"><description><title-info><genre>unrecognised</genre></title-info><document-info><program-used>pandoc</program-used></document-info></description><body><title></title><section><title>Simple title</title>This example tests FictionBook titles.</section><section><title><emphasis>Emphasized</emphasis> Strong Title</title></section></body></FictionBook>

test/fb2/titles.markdown+1−1

@@ -1,6 +1,6 @@

11# Simple title

3−This example tests if Pandoc doesn't insert forbidden elements in FictionBook titles.

3+This example tests FictionBook titles.

55# *Emphasized* **Strong** Title

test/writer.fb2+101−87

@@ -33,11 +33,15 @@

3333</title>

3434<section>

3535<title>

36−Level 2 with an embedded link </url>

36+Level 2 with an embedded link<a l:href="#l1" type="note">

37+[1]

38+</a>

39+

3740</title>

3841<section>

3942<title>

40−Level 3 with emphasis

43+Level 3 with <emphasis>emphasis</emphasis>

44+

4145</title>

4246<section>

4347<title>

@@ -58,7 +62,8 @@

5862</title>

5963<section>

6064<title>

61−Level 2 with emphasis

65+Level 2 with <emphasis>emphasis</emphasis>

66+

6267</title>

6368<section>

6469<title>

@@ -485,8 +490,8 @@

485490</title>

486491This is <emphasis>emphasized</emphasis>, and so <emphasis>is this</emphasis>.

487492This is strong, and so is this.

488−An <emphasis>emphasized link<a l:href="#l1" type="note">

489−[1]

493+An <emphasis>emphasized link<a l:href="#l2" type="note">

494+[2]

490495</a>

491496</emphasis>.

492497

@@ -526,8 +531,8 @@

526531‘A’, ‘B’, and ‘C’ are letters.

527532‘Oak,’ ‘elm,’ and ‘beech’ are names of trees. So is ‘pine.’

528533‘He said, “I want to go.”’ Were you alive in the 70’s?

529−Here is some quoted ‘<code>code</code>’ and a “quoted link<a l:href="#l2" type="note">

530−[2]

534+Here is some quoted ‘<code>code</code>’ and a “quoted link<a l:href="#l3" type="note">

535+[3]

531536</a>”.

532537Some dashes: one—two — three—four — five.

533538Dashes between numbers: 5–7, 255–66, 1987–1999.

@@ -606,10 +611,7 @@

606611<title>

607612Explicit

608613</title>

609−Just a URL<a l:href="#l3" type="note">

610−[3]

611−</a>.

612−URL and title<a l:href="#l4" type="note">

614+Just a URL<a l:href="#l4" type="note">

613615[4]

614616</a>.

615617URL and title<a l:href="#l5" type="note">

@@ -620,97 +622,100 @@

620622</a>.

621623URL and title<a l:href="#l7" type="note">

622624[7]

623−</a>

624−

625+</a>.

625626URL and title<a l:href="#l8" type="note">

626627[8]

627628</a>

628629

629−with_underscore<a l:href="#l9" type="note">

630+URL and title<a l:href="#l9" type="note">

630631[9]

631632</a>

632633

633−Email link<a l:href="#l10" type="note">

634+with_underscore<a l:href="#l10" type="note">

634635[10]

635636</a>

636637

637−Empty<a l:href="#l11" type="note">

638+Email link<a l:href="#l11" type="note">

638639[11]

640+</a>

641+

642+Empty<a l:href="#l12" type="note">

643+[12]

639644</a>.

640645</section>

641646<section>

642647<title>

643648Reference

644649</title>

645−Foo bar<a l:href="#l12" type="note">

646−[12]

647−</a>.

648−With embedded [brackets]<a l:href="#l13" type="note">

650+Foo bar<a l:href="#l13" type="note">

649651[13]

650652</a>.

651−b<a l:href="#l14" type="note">

653+With embedded [brackets]<a l:href="#l14" type="note">

652654[14]

653−</a> by itself should be a link.

654−Indented once<a l:href="#l15" type="note">

655−[15]

656655</a>.

657−Indented twice<a l:href="#l16" type="note">

656+b<a l:href="#l15" type="note">

657+[15]

658+</a> by itself should be a link.

659+Indented once<a l:href="#l16" type="note">

658660[16]

659661</a>.

660−Indented thrice<a l:href="#l17" type="note">

662+Indented twice<a l:href="#l17" type="note">

661663[17]

662664</a>.

665+Indented thrice<a l:href="#l18" type="note">

666+[18]

667+</a>.

663668This should [not][] be a link.

664669<empty-line />

665670

666671<code>[not]: /url</code>

667672

668673<empty-line />

669−Foo bar<a l:href="#l18" type="note">

670−[18]

671−</a>.

672−Foo biz<a l:href="#l19" type="note">

674+Foo bar<a l:href="#l19" type="note">

673675[19]

674676</a>.

677+Foo biz<a l:href="#l20" type="note">

678+[20]

679+</a>.

675680</section>

676681<section>

677682<title>

678683With ampersands

679684</title>

680−Here’s a link with an ampersand in the URL<a l:href="#l20" type="note">

681−[20]

682−</a>.

683−Here’s a link with an amersand in the link text: AT&T<a l:href="#l21" type="note">

685+Here’s a link with an ampersand in the URL<a l:href="#l21" type="note">

684686[21]

685687</a>.

686−Here’s an inline link<a l:href="#l22" type="note">

688+Here’s a link with an amersand in the link text: AT&T<a l:href="#l22" type="note">

687689[22]

688690</a>.

689−Here’s an inline link in pointy braces<a l:href="#l23" type="note">

691+Here’s an inline link<a l:href="#l23" type="note">

690692[23]

691693</a>.

694+Here’s an inline link in pointy braces<a l:href="#l24" type="note">

695+[24]

696+</a>.

692697</section>

693698<section>

694699<title>

695700Autolinks

696701</title>

697−With an ampersand: http://example.com/?foo=1&bar=2<a l:href="#l24" type="note">

698−[24]

702+With an ampersand: http://example.com/?foo=1&bar=2<a l:href="#l25" type="note">

703+[25]

699704</a>

700705

701706• In a list?

702−• http://example.com/<a l:href="#l25" type="note">

703−[25]

707+• http://example.com/<a l:href="#l26" type="note">

708+[26]

704709</a>

705710

706711• It should.

707−An e-mail address: nobody@nowhere.net<a l:href="#l26" type="note">

708−[26]

712+An e-mail address: nobody@nowhere.net<a l:href="#l27" type="note">

713+[27]

709714</a>

710715

711716<cite>

712−Blockquoted: http://example.com/<a l:href="#l27" type="note">

713−[27]

717+Blockquoted: http://example.com/<a l:href="#l28" type="note">

718+[28]

714719</a>

715720

716721</cite>

@@ -741,22 +746,22 @@

741746<title>

742747Footnotes

743748</title>

744−Here is a footnote reference,<a l:href="#n28" type="note">

745−[28]

746−</a> and another.<a l:href="#n29" type="note">

749+Here is a footnote reference,<a l:href="#n29" type="note">

747750[29]

748−</a> This should <emphasis>not</emphasis> be a footnote reference, because it contains a space.[^my note] Here is an inline note.<a l:href="#n30" type="note">

751+</a> and another.<a l:href="#n30" type="note">

749752[30]

753+</a> This should <emphasis>not</emphasis> be a footnote reference, because it contains a space.[^my note] Here is an inline note.<a l:href="#n31" type="note">

754+[31]

750755</a>

751756

752757<cite>

753−Notes can go in quotes.<a l:href="#n31" type="note">

754−[31]

758+Notes can go in quotes.<a l:href="#n32" type="note">

759+[32]

755760</a>

756761

757762</cite>

758−1. And in list items.<a l:href="#n32" type="note">

759−[32]

763+1. And in list items.<a l:href="#n33" type="note">

764+[33]

760765</a>

761766

762767This paragraph should not be part of the note, as it is not indented.

@@ -776,7 +781,7 @@

7767812

777782</title>

778783

779−<code>http://example.com/?foo=1&bar=2</code>

784+<code>/url</code>

780785

781786</section>

782787<section id="l3">

@@ -784,50 +789,50 @@

7847893

785790</title>

786791

787−<code>/url/</code>

792+<code>http://example.com/?foo=1&bar=2</code>

788793

789794</section>

790795<section id="l4">

791796<title>

7927974

793798</title>

794−title: <code>/url/</code>

799+

800+<code>/url/</code>

795801

796802</section>

797803<section id="l5">

798804<title>

7998055

800806</title>

801−title preceded by two spaces: <code>/url/</code>

807+title: <code>/url/</code>

802808

803809</section>

804810<section id="l6">

805811<title>

8068126

807813</title>

808−title preceded by a tab: <code>/url/</code>

814+title preceded by two spaces: <code>/url/</code>

809815

810816</section>

811817<section id="l7">

812818<title>

8138197

814820</title>

815−title with "quotes" in it: <code>/url/</code>

821+title preceded by a tab: <code>/url/</code>

816822

817823</section>

818824<section id="l8">

819825<title>

8208268

821827</title>

822−title with single quotes: <code>/url/</code>

828+title with "quotes" in it: <code>/url/</code>

823829

824830</section>

825831<section id="l9">

826832<title>

8278339

828834</title>

829−

830−<code>/url/with_underscore</code>

835+title with single quotes: <code>/url/</code>

831836

832837</section>

833838<section id="l10">

@@ -835,7 +840,7 @@

83584010

836841</title>

837842

838−<code>mailto:nobody@nowhere.net</code>

843+<code>/url/with_underscore</code>

839844

840845</section>

841846<section id="l11">

@@ -843,8 +848,7 @@

84384811

844849</title>

845850

846−<code>

847−</code>

851+<code>mailto:nobody@nowhere.net</code>

848852

849853</section>

850854<section id="l12">

@@ -852,7 +856,8 @@

85285612

853857</title>

854858

855−<code>/url/</code>

859+<code>

860+</code>

856861

857862</section>

858863<section id="l13">

@@ -876,7 +881,7 @@

87688115

877882</title>

878883

879−<code>/url</code>

884+<code>/url/</code>

880885

881886</section>

882887<section id="l16">

@@ -899,37 +904,37 @@

899904<title>

90090518

901906</title>

902−Title with "quotes" inside: <code>/url/</code>

907+

908+<code>/url</code>

903909

904910</section>

905911<section id="l19">

906912<title>

90791319

908914</title>

909−Title with "quote" inside: <code>/url/</code>

915+Title with "quotes" inside: <code>/url/</code>

910916

911917</section>

912918<section id="l20">

913919<title>

91492020

915921</title>

916−

917−<code>http://example.com/?foo=1&bar=2</code>

922+Title with "quote" inside: <code>/url/</code>

918923

919924</section>

920925<section id="l21">

921926<title>

92292721

923928</title>

924−AT&T: <code>http://att.com/</code>

929+

930+<code>http://example.com/?foo=1&bar=2</code>

925931

926932</section>

927933<section id="l22">

928934<title>

92993522

930936</title>

931−

932−<code>/script?foo=1&bar=2</code>

937+AT&T: <code>http://att.com/</code>

933938

934939</section>

935940<section id="l23">

@@ -945,7 +950,7 @@

94595024

946951</title>

947952

948−<code>http://example.com/?foo=1&bar=2</code>

953+<code>/script?foo=1&bar=2</code>

949954

950955</section>

951956<section id="l25">

@@ -953,7 +958,7 @@

95395825

954959</title>

955960

956−<code>http://example.com/</code>

961+<code>http://example.com/?foo=1&bar=2</code>

957962

958963</section>

959964<section id="l26">

@@ -961,7 +966,7 @@

96196626

962967</title>

963968

964−<code>mailto:nobody@nowhere.net</code>

969+<code>http://example.com/</code>

965970

966971</section>

967972<section id="l27">

@@ -969,19 +974,27 @@

96997427

970975</title>

971976

972−<code>http://example.com/</code>

977+<code>mailto:nobody@nowhere.net</code>

973978

974979</section>

975−<section id="n28">

980+<section id="l28">

976981<title>

97798228

978983</title>

979−Here is the footnote. It can go anywhere after the footnote reference. It need not be placed at the end of the document.

984+

985+<code>http://example.com/</code>

986+

980987</section>

981988<section id="n29">

982989<title>

98399029

984991</title>

992+Here is the footnote. It can go anywhere after the footnote reference. It need not be placed at the end of the document.

993+</section>

994+<section id="n30">

995+<title>

996+30

997+</title>

985998Here’s the long note. This one contains multiple blocks.

986999Subsequent blocks are indented to show that they belong to the footnote (as with list items).

9871000<empty-line />

@@ -991,25 +1004,26 @@

9911004<empty-line />

9921005If you want, you can indent every line, but you can also be lazy and just indent the first line of each block.

9931006</section>

994−<section id="n30">

1007+<section id="n31">

9951008<title>

996−30

1009+31

9971010</title>

998−This is <emphasis>easier</emphasis> to type. Inline notes may contain links<a l:href="#l30" type="note">

999−[30]

1011+This is <emphasis>easier</emphasis> to type. Inline notes may contain links<a l:href="#l31" type="note">

1012+[31]

10001013</a> and <code>]</code> verbatim characters, as well as [bracketed text].

10011014</section>

1002−<section id="n31">

1015+<section id="n32">

10031016<title>

1004−31

1017+32

10051018</title>

10061019In quote.

10071020</section>

1008−<section id="n32">

1021+<section id="n33">

10091022<title>

1010−32

1023+33

10111024</title>

10121025In list.

10131026</section>

10141027</body>

10151028</FictionBook>

1029+