From 9f2d1b933897a6330e5c8f9fa904e56ab40050ef Mon Sep 17 00:00:00 2001 From: Alec Theriault Date: Sat, 4 Aug 2018 11:51:30 -0400 Subject: Latex type families (#734) * Support for type families in LaTeX The code is ported over from the XHTML backend. * Refactor XHTML and LaTeX family handling This is mostly a consolidation effort: stripping extra exports, inlining some short definitions, and trying to make the backends match. The LaTeX backend now has preliminary support for data families, although the only the data instance head is printed (not the actual constructors). Both backends also now use "newtype" for newtype data family instances. * Add some tests --- html-test/ref/TypeFamilies3.html | 356 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 356 insertions(+) create mode 100644 html-test/ref/TypeFamilies3.html (limited to 'html-test/ref/TypeFamilies3.html') diff --git a/html-test/ref/TypeFamilies3.html b/html-test/ref/TypeFamilies3.html new file mode 100644 index 00000000..2dadf435 --- /dev/null +++ b/html-test/ref/TypeFamilies3.html @@ -0,0 +1,356 @@ +TypeFamilies3

Safe HaskellSafe

TypeFamilies3

Synopsis
  • type family Foo a where ...
  • type family Bar a
  • data family Baz a

Documentation

type family Foo a where ... #

A closed type family

Equations

Foo () = Int
Foo _ = ()

type family Bar a #

An open family

Instances
type Bar Int #
Instance details

Defined in TypeFamilies3

type Bar Int = ()
type Bar () #
Instance details

Defined in TypeFamilies3

type Bar () = Int

data family Baz a #

A data family

Instances
newtype Baz Double #
Instance details

Defined in TypeFamilies3

newtype Baz Double = Baz3 Float
data Baz Int #
Instance details

Defined in TypeFamilies3

data Baz Int = Baz2 Bool
data Baz () #
Instance details

Defined in TypeFamilies3

data Baz () = Baz1
\ No newline at end of file -- cgit v1.2.3 From f0e05fca8553b97f65c3102090848b8c4cf9e609 Mon Sep 17 00:00:00 2001 From: Alec Theriault Date: Thu, 18 Oct 2018 08:25:36 -0700 Subject: Accept tests --- html-test/ref/Bug574.html | 10 ++++++---- html-test/ref/ConstructorArgs.html | 10 ++++++---- html-test/ref/GadtConstructorArgs.html | 10 ++++++---- html-test/ref/QuantifiedConstraints.html | 10 ++++++---- html-test/ref/Table.html | 18 +++++++++--------- html-test/ref/TypeFamilies3.html | 10 ++++++---- html-test/ref/Unicode2.html | 10 ++++++---- 7 files changed, 45 insertions(+), 33 deletions(-) (limited to 'html-test/ref/TypeFamilies3.html') diff --git a/html-test/ref/Bug574.html b/html-test/ref/Bug574.html index ed0a5e15..ab24218e 100644 --- a/html-test/ref/Bug574.html +++ b/html-test/ref/Bug574.html @@ -1,9 +1,11 @@ Bug574
ConstructorArgs
GadtConstructorArgs
QuantifiedConstraints
Header row, column 1 + > Header row, column 1 (header rows optional) Header 2 + > Header 2 Header 3 + > Header 3 Header 4 + > Header 4 body row 3 Cells may - span rows. + > Cells may + span rows. \[ - f(n) = \sum_{i=1} + > \[ + f(n) = \sum_{i=1} \]
+> \ No newline at end of file diff --git a/html-test/ref/TypeFamilies3.html b/html-test/ref/TypeFamilies3.html index 2dadf435..fa270191 100644 --- a/html-test/ref/TypeFamilies3.html +++ b/html-test/ref/TypeFamilies3.html @@ -1,9 +1,11 @@ TypeFamilies3
Unicode2
Date: Mon, 5 Nov 2018 13:58:11 -0800 Subject: Only run MathJax on entities with "mathjax" class (#960) Correspondingly, we wrap all inline/diplay math in ... the math .... This fixes #959. --- haddock-api/src/Haddock/Backends/Xhtml.hs | 24 ++++++++++++++-------- .../src/Haddock/Backends/Xhtml/DocMarkup.hs | 4 ++-- html-test/ref/A.html | 4 +++- html-test/ref/Bold.html | 4 +++- html-test/ref/Bug1.html | 4 +++- html-test/ref/Bug195.html | 4 +++- html-test/ref/Bug2.html | 4 +++- html-test/ref/Bug201.html | 4 +++- html-test/ref/Bug253.html | 4 +++- html-test/ref/Bug26.html | 4 +++- html-test/ref/Bug280.html | 4 +++- html-test/ref/Bug294.html | 4 +++- html-test/ref/Bug298.html | 4 +++- html-test/ref/Bug3.html | 4 +++- html-test/ref/Bug308.html | 4 +++- html-test/ref/Bug308CrossModule.html | 4 +++- html-test/ref/Bug310.html | 4 +++- html-test/ref/Bug313.html | 4 +++- html-test/ref/Bug335.html | 4 +++- html-test/ref/Bug387.html | 4 +++- html-test/ref/Bug4.html | 4 +++- html-test/ref/Bug458.html | 4 +++- html-test/ref/Bug546.html | 4 +++- html-test/ref/Bug548.html | 4 +++- html-test/ref/Bug574.html | 4 +++- html-test/ref/Bug6.html | 4 +++- html-test/ref/Bug613.html | 4 +++- html-test/ref/Bug647.html | 4 +++- html-test/ref/Bug679.html | 4 +++- html-test/ref/Bug7.html | 4 +++- html-test/ref/Bug8.html | 4 +++- html-test/ref/Bug85.html | 4 +++- html-test/ref/Bug953.html | 4 +++- html-test/ref/BugDeprecated.html | 4 +++- html-test/ref/BugExportHeadings.html | 4 +++- html-test/ref/Bugs.html | 4 +++- html-test/ref/BundledPatterns.html | 4 +++- html-test/ref/BundledPatterns2.html | 4 +++- html-test/ref/ConstructorArgs.html | 4 +++- html-test/ref/ConstructorPatternExport.html | 4 +++- html-test/ref/DeprecatedClass.html | 4 +++- html-test/ref/DeprecatedData.html | 4 +++- html-test/ref/DeprecatedFunction.html | 4 +++- html-test/ref/DeprecatedFunction2.html | 4 +++- html-test/ref/DeprecatedFunction3.html | 4 +++- html-test/ref/DeprecatedModule.html | 4 +++- html-test/ref/DeprecatedModule2.html | 4 +++- html-test/ref/DeprecatedNewtype.html | 4 +++- html-test/ref/DeprecatedReExport.html | 4 +++- html-test/ref/DeprecatedRecord.html | 4 +++- html-test/ref/DeprecatedTypeFamily.html | 4 +++- html-test/ref/DeprecatedTypeSynonym.html | 4 +++- html-test/ref/DuplicateRecordFields.html | 4 +++- html-test/ref/Examples.html | 4 +++- html-test/ref/Extensions.html | 4 +++- html-test/ref/FunArgs.html | 4 +++- html-test/ref/GADTRecords.html | 4 +++- html-test/ref/GadtConstructorArgs.html | 4 +++- html-test/ref/Hash.html | 4 +++- html-test/ref/HiddenInstances.html | 4 +++- html-test/ref/HiddenInstancesB.html | 4 +++- html-test/ref/Hyperlinks.html | 4 +++- html-test/ref/ImplicitParams.html | 4 +++- html-test/ref/Instances.html | 4 +++- html-test/ref/Math.html | 22 ++++++++++++++------ html-test/ref/Minimal.html | 4 +++- html-test/ref/ModuleWithWarning.html | 4 +++- html-test/ref/NamedDoc.html | 4 +++- html-test/ref/Nesting.html | 4 +++- html-test/ref/NoLayout.html | 4 +++- html-test/ref/NonGreedy.html | 4 +++- html-test/ref/Operators.html | 4 +++- html-test/ref/OrphanInstances.html | 4 +++- html-test/ref/OrphanInstancesClass.html | 4 +++- html-test/ref/OrphanInstancesType.html | 4 +++- html-test/ref/PR643.html | 4 +++- html-test/ref/PR643_1.html | 4 +++- html-test/ref/PatternSyns.html | 4 +++- html-test/ref/PromotedTypes.html | 4 +++- html-test/ref/Properties.html | 4 +++- html-test/ref/PruneWithWarning.html | 4 +++- html-test/ref/QuantifiedConstraints.html | 4 +++- html-test/ref/QuasiExpr.html | 4 +++- html-test/ref/QuasiQuote.html | 4 +++- html-test/ref/SpuriousSuperclassConstraints.html | 4 +++- html-test/ref/TH.html | 4 +++- html-test/ref/TH2.html | 4 +++- html-test/ref/Table.html | 10 ++++++--- html-test/ref/Test.html | 4 +++- html-test/ref/Threaded.html | 4 +++- html-test/ref/Threaded_TH.html | 4 +++- html-test/ref/Ticket112.html | 4 +++- html-test/ref/Ticket61.html | 4 +++- html-test/ref/Ticket75.html | 4 +++- html-test/ref/TitledPicture.html | 4 +++- html-test/ref/TypeFamilies.html | 4 +++- html-test/ref/TypeFamilies2.html | 4 +++- html-test/ref/TypeFamilies3.html | 4 +++- html-test/ref/TypeOperators.html | 4 +++- html-test/ref/Unicode.html | 4 +++- html-test/ref/Unicode2.html | 4 +++- html-test/ref/Visible.html | 4 +++- 102 files changed, 334 insertions(+), 118 deletions(-) (limited to 'html-test/ref/TypeFamilies3.html') diff --git a/haddock-api/src/Haddock/Backends/Xhtml.hs b/haddock-api/src/Haddock/Backends/Xhtml.hs index 6da6a2e8..0a11ca08 100644 --- a/haddock-api/src/Haddock/Backends/Xhtml.hs +++ b/haddock-api/src/Haddock/Backends/Xhtml.hs @@ -120,17 +120,23 @@ copyHtmlBits odir libdir themes withQuickjump = do headHtml :: String -> Themes -> Maybe String -> Html headHtml docTitle themes mathjax_url = - header << [ - meta ! [httpequiv "Content-Type", content "text/html; charset=UTF-8"], - thetitle << docTitle, - styleSheet themes, - thelink ! [ rel "stylesheet", thetype "text/css", href quickJumpCssFile] << noHtml, - script ! [src haddockJsFile, emptyAttr "async", thetype "text/javascript"] << noHtml, - script ! [src mjUrl, thetype "text/javascript"] << noHtml + header << + [ meta ! [httpequiv "Content-Type", content "text/html; charset=UTF-8"] + , thetitle << docTitle + , styleSheet themes + , thelink ! [ rel "stylesheet", thetype "text/css", href quickJumpCssFile] << noHtml + , script ! [src haddockJsFile, emptyAttr "async", thetype "text/javascript"] << noHtml + , script ! [thetype "text/x-mathjax-config"] << primHtml mjConf + , script ! [src mjUrl, thetype "text/javascript"] << noHtml ] where - mjUrl = maybe "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" id mathjax_url - + mjUrl = maybe "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" id mathjax_url + mjConf = unwords [ "MathJax.Hub.Config({" + , "tex2jax: {" + , "processClass: \"mathjax\"," + , "ignoreClass: \".*\"" + , "}" + , "});" ] srcButton :: SourceURLs -> Maybe Interface -> Maybe Html srcButton (Just src_base_url, _, _, _) Nothing = diff --git a/haddock-api/src/Haddock/Backends/Xhtml/DocMarkup.hs b/haddock-api/src/Haddock/Backends/Xhtml/DocMarkup.hs index ed323a90..38aa7b7e 100644 --- a/haddock-api/src/Haddock/Backends/Xhtml/DocMarkup.hs +++ b/haddock-api/src/Haddock/Backends/Xhtml/DocMarkup.hs @@ -69,8 +69,8 @@ parHtmlMarkup qual insertAnchors ppId = Markup { then namedAnchor aname << "" else noHtml, markupPic = \(Picture uri t) -> image ! ([src uri] ++ fromMaybe [] (return . title <$> t)), - markupMathInline = \mathjax -> toHtml ("\\(" ++ mathjax ++ "\\)"), - markupMathDisplay = \mathjax -> toHtml ("\\[" ++ mathjax ++ "\\]"), + markupMathInline = \mathjax -> thespan ! [theclass "mathjax"] << toHtml ("\\(" ++ mathjax ++ "\\)"), + markupMathDisplay = \mathjax -> thespan ! [theclass "mathjax"] << toHtml ("\\[" ++ mathjax ++ "\\]"), markupProperty = pre . toHtml, markupExample = examplesToHtml, markupHeader = \(Header l t) -> makeHeader l t, diff --git a/html-test/ref/A.html b/html-test/ref/A.html index e4802966..75fbb9ed 100644 --- a/html-test/ref/A.html +++ b/html-test/ref/A.html @@ -7,7 +7,9 @@ />normalDensity

\[ + >\[ \int_{-\infty}^{\infty} e^{-x^2/2} = \sqrt{2\pi} - \]

\(\int_{-\infty}^{\infty} e^{-x^2/2} = \sqrt{2\pi}\)

\(\int_{-\infty}^{\infty} e^{-x^2/2} = \sqrt{2\pi}\)

Math (inline) for normalDensity - \(\int_{-\infty}^{\infty} e^{-x^2/2} = \sqrt{2\pi}\) - \[\int_{-\infty}^{\infty} e^{-x^2/2} = \sqrt{2\pi}\]

\(\int_{-\infty}^{\infty} e^{-x^2/2} = \sqrt{2\pi}\) + \[\int_{-\infty}^{\infty} e^{-x^2/2} = \sqrt{2\pi}\]

\[ + > \[ f(n) = \sum_{i=1} - \] Date: Wed, 7 Nov 2018 13:45:15 -0800 Subject: Accept HTML output changes --- html-test/ref/Bug26.html | 10 +- html-test/ref/Bug294.html | 34 ++++--- html-test/ref/Bug387.html | 26 ++--- html-test/ref/Bug548.html | 8 +- html-test/ref/Bug613.html | 18 ++-- html-test/ref/Bug679.html | 18 ++-- html-test/ref/Bug7.html | 18 ++-- html-test/ref/BugExportHeadings.html | 58 +++++------ html-test/ref/DeprecatedReExport.html | 26 ++--- html-test/ref/Hash.html | 58 ++++++----- html-test/ref/HiddenInstances.html | 18 ++-- html-test/ref/HiddenInstancesB.html | 18 ++-- html-test/ref/Instances.html | 50 ++++++---- html-test/ref/OrphanInstances.html | 20 ++-- html-test/ref/OrphanInstancesClass.html | 10 +- html-test/ref/OrphanInstancesType.html | 10 +- html-test/ref/QuasiExpr.html | 18 ++-- html-test/ref/SpuriousSuperclassConstraints.html | 10 +- html-test/ref/Test.html | 120 ++++++++++++----------- html-test/ref/TypeFamilies.html | 74 ++++++++------ html-test/ref/TypeFamilies2.html | 26 +++-- html-test/ref/TypeFamilies3.html | 16 +-- 22 files changed, 381 insertions(+), 283 deletions(-) (limited to 'html-test/ref/TypeFamilies3.html') diff --git a/html-test/ref/Bug26.html b/html-test/ref/Bug26.html index 97f69317..97cf5b24 100644 --- a/html-test/ref/Bug26.html +++ b/html-test/ref/Bug26.html @@ -149,9 +149,11 @@ >
Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/Bug294.html b/html-test/ref/Bug294.html index 528696e6..2dfd775f 100644 --- a/html-test/ref/Bug294.html +++ b/html-test/ref/Bug294.html @@ -53,9 +53,11 @@ >#

Instances

Instances

Instances details
#

Instances

Instances

Instances details
#

Instances

Instances

Instances details
#

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/Bug387.html b/html-test/ref/Bug387.html index ccdeb642..a6b19759 100644 --- a/html-test/ref/Bug387.html +++ b/html-test/ref/Bug387.html @@ -41,18 +41,20 @@ >Bug387

+> \ No newline at end of file diff --git a/html-test/ref/Bug548.html b/html-test/ref/Bug548.html index 8ccd244b..3778cd9e 100644 --- a/html-test/ref/Bug548.html +++ b/html-test/ref/Bug548.html @@ -91,9 +91,11 @@ >
Instances

Instances

Instances details

Instances

Instances

Instances details
Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/Bug679.html b/html-test/ref/Bug679.html index d0d0a69d..4a5e7154 100644 --- a/html-test/ref/Bug679.html +++ b/html-test/ref/Bug679.html @@ -67,9 +67,11 @@ >
Instances

Instances

Instances details

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/Bug7.html b/html-test/ref/Bug7.html index 08a87751..faeb61af 100644 --- a/html-test/ref/Bug7.html +++ b/html-test/ref/Bug7.html @@ -102,9 +102,11 @@ >
Instances

Instances

Instances details
The Bar class

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/BugExportHeadings.html b/html-test/ref/BugExportHeadings.html index 4c2e822e..19f19778 100644 --- a/html-test/ref/BugExportHeadings.html +++ b/html-test/ref/BugExportHeadings.html @@ -41,34 +41,36 @@ >BugExportHeadings

+> \ No newline at end of file diff --git a/html-test/ref/DeprecatedReExport.html b/html-test/ref/DeprecatedReExport.html index 9b6bc3f1..a2c9b4f2 100644 --- a/html-test/ref/DeprecatedReExport.html +++ b/html-test/ref/DeprecatedReExport.html @@ -41,18 +41,20 @@ >DeprecatedReExport

+> \ No newline at end of file diff --git a/html-test/ref/Hash.html b/html-test/ref/Hash.html index 6c489505..69afe1aa 100644 --- a/html-test/ref/Hash.html +++ b/html-test/ref/Hash.html @@ -41,30 +41,32 @@ >Hash

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/HiddenInstances.html b/html-test/ref/HiddenInstances.html index 3a03d2ba..a41327e5 100644 --- a/html-test/ref/HiddenInstances.html +++ b/html-test/ref/HiddenInstances.html @@ -77,9 +77,11 @@ >Should be visible

Instances

Instances

Instances details
Should be visible

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/HiddenInstancesB.html b/html-test/ref/HiddenInstancesB.html index f6b4db1e..80acad2e 100644 --- a/html-test/ref/HiddenInstancesB.html +++ b/html-test/ref/HiddenInstancesB.html @@ -77,9 +77,11 @@ >Should be visible

Instances

Instances

Instances details
Should be visible

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/Instances.html b/html-test/ref/Instances.html index e2f16a49..957adde1 100644 --- a/html-test/ref/Instances.html +++ b/html-test/ref/Instances.html @@ -67,9 +67,11 @@ >
Instances

Instances

Instances details

Instances

Instances

Instances details

Instances

Instances

Instances details

Instances

Instances

Instances details
Instances

Instances

Instances details

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/OrphanInstances.html b/html-test/ref/OrphanInstances.html index d0d19e2f..d6cbcf8e 100644 --- a/html-test/ref/OrphanInstances.html +++ b/html-test/ref/OrphanInstances.html @@ -41,14 +41,16 @@ >OrphanInstances

+> \ No newline at end of file diff --git a/html-test/ref/OrphanInstancesClass.html b/html-test/ref/OrphanInstancesClass.html index 04193c50..925f7ada 100644 --- a/html-test/ref/OrphanInstancesClass.html +++ b/html-test/ref/OrphanInstancesClass.html @@ -67,9 +67,11 @@ >

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/OrphanInstancesType.html b/html-test/ref/OrphanInstancesType.html index 67acfcd5..7b40b3cb 100644 --- a/html-test/ref/OrphanInstancesType.html +++ b/html-test/ref/OrphanInstancesType.html @@ -69,9 +69,11 @@ >
Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/QuasiExpr.html b/html-test/ref/QuasiExpr.html index 88f1b92c..3c1aff57 100644 --- a/html-test/ref/QuasiExpr.html +++ b/html-test/ref/QuasiExpr.html @@ -103,9 +103,11 @@ >
Instances

Instances

Instances details
Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/SpuriousSuperclassConstraints.html b/html-test/ref/SpuriousSuperclassConstraints.html index 17c026d1..61841f06 100644 --- a/html-test/ref/SpuriousSuperclassConstraints.html +++ b/html-test/ref/SpuriousSuperclassConstraints.html @@ -79,9 +79,11 @@ Fix spurious superclass constraints bug.#

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/Test.html b/html-test/ref/Test.html index 5cdee91e..b7f93128 100644 --- a/html-test/ref/Test.html +++ b/html-test/ref/Test.html @@ -71,62 +71,64 @@ >Test

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/TypeFamilies.html b/html-test/ref/TypeFamilies.html index 35f9e542..d31e9f7b 100644 --- a/html-test/ref/TypeFamilies.html +++ b/html-test/ref/TypeFamilies.html @@ -211,9 +211,11 @@ >
Instances

Instances

Instances details
Doc for: data Y

Instances

Instances

Instances details
Instances

Instances

Instances details
Doc for: class Test a

Instances

Instances

Instances details
Doc for: type family Foo a

Instances

Instances

Instances details
Doc for: data family Bat a

Instances

Instances

Instances details
Instances

Instances

Instances details
#

Instances

Instances

Instances details
#

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/TypeFamilies2.html b/html-test/ref/TypeFamilies2.html index 4c6fcc74..a60ce077 100644 --- a/html-test/ref/TypeFamilies2.html +++ b/html-test/ref/TypeFamilies2.html @@ -83,9 +83,11 @@ >Exported type

Instances

Instances

Instances details
Exported type family

Instances

Instances

Instances details
Exported data family

Instances

Instances

Instances details
+> \ No newline at end of file diff --git a/html-test/ref/TypeFamilies3.html b/html-test/ref/TypeFamilies3.html index fa270191..a7e60ce1 100644 --- a/html-test/ref/TypeFamilies3.html +++ b/html-test/ref/TypeFamilies3.html @@ -125,9 +125,11 @@ >An open family

Instances

Instances

Instances details
A data family

Instances

Instances

Instances details