HaTeX 3.16.1.1 → 3.16.2.0

raw patch · 4 files changed

+54/−20 lines, 4 filesPVP: major bump suggested

API removals or changes: PVP suggests a major version bump

API changes (from Hackage documentation)

Files

• CHANGELOG.md +12/−0
• HaTeX.cabal +2/−2
• README.md +12/−9
• Text/LaTeX/Packages/AMSMath.hs +28/−9

@@ -9,6 +9,18 @@  # Changelog by versions +## From 3.16.1.1 to 3.16.2.0++* New differentiation symbols (AMSMath).+* Fix for integralFromTo.+* Extend definitions for the Num class instance of LaTeXT.+* Show and Eq instances of LaTeXT dissappear if base version+  is greater or equal to 4.5.0.0.++## From 3.16.1.0 to 3.16.1.1++* Full compatibility without warnings with GHC-7.10.+ ## From 3.16.0.0 to 3.16.1.0  * Pretty-printer: Use softline instead of line after commands.

@@ -1,5 +1,5 @@ Name: HaTeX
-Version: 3.16.1.1
+Version: 3.16.2.0
 Author: Daniel Díaz
 Category: LaTeX
 Build-type: Simple
@@ -7,7 +7,7 @@ License-file: license
 Maintainer: Daniel Díaz (dhelta `dot` diaz `at` gmail `dot` com)
 Bug-reports: https://github.com/Daniel-Diaz/HaTeX/issues
-homepage: http://wrongurl.net/haskell/HaTeX
+homepage: https://github.com/Daniel-Diaz/HaTeX/blob/master/README.md
 Synopsis: The Haskell LaTeX library.
 Description: This library implements the LaTeX syntax and provides some useful abstractions.
              .

@@ -1,10 +1,11 @@+ # The HaTeX library -HaTeX is a Haskell library that implements the *LaTeX syntax*, plus some abstractions over it.+HaTeX is a Haskell library that implements the *LaTeX syntax*, plus some abstractions on top.  Check a list of usage examples in the [Examples](https://github.com/Daniel-Diaz/HaTeX/tree/master/Examples) directory of the repository in GitHub.-A good starting point may be [simple.hs](https://github.com/Daniel-Diaz/HaTeX/blob/master/Examples/simple.hs).+A good starting point is [simple.hs](https://github.com/Daniel-Diaz/HaTeX/blob/master/Examples/simple.hs). Run any example script executing the ``main`` function.  ## Installation notes@@ -18,23 +19,25 @@ If you want to try a newer version, use _git_ to clone the code contained in this repository. -    $ git clone git@github.com:Daniel-Diaz/HaTeX.git+    $ git clone https://github.com/Daniel-Diaz/HaTeX.git     $ cd HaTeX     $ cabal install -However, note that the API may be unstable and is subject to any kind of change.-In the other hand, this package follows the [_Package Versioning Policy_](http://www.haskell.org/haskellwiki/Package_versioning_policy),+However, this is not recommended as it may include some bugs or oddities due to in-development features.+Note that this package follows the [_Package Versioning Policy_](http://www.haskell.org/haskellwiki/Package_versioning_policy), so it is unlikely to suffer from API breakages if you follow it too when importing the library (assuming you are using the version in Hackage). -See the [Hackage page of HaTeX](http://hackage.haskell.org/package/HaTeX) to browse older versions.+## HaTeX in Hackage +[![HaTeX in Hackage](https://img.shields.io/hackage/v/HaTeX.svg)](https://hackage.haskell.org/package/HaTeX)+ ## HaTeX User's Guide  The HaTeX User's Guide lives [here](https://github.com/Daniel-Diaz/hatex-guide)... and is also done in Haskell! It is free source and anybody can contribute to it. Doing so, you will help current and future users! -A downloadable version (not necessarily the last version, but most likely)+A downloadable version (not necessarily the latest version, but most likely) can be found [here](http://daniel-diaz.github.com/projects/hatex/hatex-guide.pdf). To be sure that you are reading the last version, go to the github repository of the guide and follow instructions to build it. It is fairly easy.@@ -60,10 +63,10 @@  ## Related projects -* [TeX-my-math](https://github.com/leftaroundabout/Symbolic-math-HaTeX): Experimental library to ease the production-of mathematical expressions using HaTeX (_no longer maintained?_). * [haskintex](http://daniel-diaz.github.io/projects/haskintex): Tool to use Haskell (and, additionaly, the HaTeX library) within a LaTeX file.+* [TeX-my-math](https://github.com/leftaroundabout/Symbolic-math-HaTeX): Experimental library to ease the production+of mathematical expressions using HaTeX (_no longer maintained?_).  ## Travis automatic build 

@@ -1,5 +1,5 @@ -{-# LANGUAGE OverloadedStrings, TypeFamilies #-}+{-# LANGUAGE CPP, OverloadedStrings, TypeFamilies #-}  -- | \AMSMath\ support. Also numeric instances ('Num', 'Fractional' and 'Floating') for 'LaTeX' and 'LaTeXT'. module Text.LaTeX.Packages.AMSMath@@ -40,10 +40,11 @@  , tsqrt    -- ** Custom function symbols  , operatorname-   -- ** Sum/Integral symbols+   -- ** Summation \/ integration \/ differentiation  , tsum , sumFromTo  , prod , prodFromTo  , integral , integralFromTo+ , partial, totald, partialOf, totaldOf    -- ** Operator symbols    -- *** Arithmetic  , cdot , times , div_@@ -185,6 +186,8 @@  ----------- LaTeXT instances +#if !MIN_VERSION_base(4,5,0)+ -- | Warning: this instance only exists for the 'Num' instance. --   This instance is defined in the "Text.LaTeX.Packages.AMSMath" module. instance Eq (LaTeXT m a) where@@ -195,6 +198,8 @@ instance Show (LaTeXT m a) where  show _ = error "Cannot use \"show\" Show method with a LaTeXT value." +#endif+ -- | Careful! Method 'signum' is undefined. Don't use it! --   This instance is defined in the "Text.LaTeX.Packages.AMSMath" module. instance (Monad m, a ~ ()) => Num (LaTeXT m a) where@@ -204,8 +209,7 @@  negate = liftFun negate  fromInteger = fromLaTeX . fromInteger  abs = liftFun abs- -- Non-defined methods- signum _ = error "Cannot use \"signum\" Num method with a LaTeXT value."+ signum = liftFun signum  -- | Division uses the LaTeX 'frac' command. --   This instance is defined in the "Text.LaTeX.Packages.AMSMath" module.@@ -231,10 +235,9 @@  sinh = liftFun sinh  tanh = liftFun tanh  cosh = liftFun cosh- -- Non-defined methods- asinh = error "Function 'asinh' is not defined in AMSMath!"- atanh = error "Function 'atabh' is not defined in AMSMath!"- acosh = error "Function 'acosh' is not defined in AMSMath!"+ asinh = liftFun asinh+ atanh = liftFun atanh+ acosh = liftFun acosh  -- | A reference to a numbered equation. Use with a 'label' defined in the -- scope of the equation refered to.@@ -443,7 +446,23 @@                => l -- ^ Lower limit of integration.                -> l -- ^ Upper limit of integration.                -> l-integralFromTo x y = commS "int" !: x ^: y+integralFromTo x y = commS "int" <> commS "limits" !: x ^: y++-- | Partial-differentiation symbol ∂+partial :: LaTeXC l => l+partial = comm0 "partial"++-- | Total-differentiation (or integration-variable) symbol d (non-italic!)+totald :: LaTeXC l => l+totald = mathrm "d"++-- | Partial-differentiation of variable, e.g. /∂x/.+partialOf :: LaTeXC l => l -> l+partialOf v = comm0 "partial" <> v++-- | Total-differentiation of variable, or integration over variable, e.g. d/x/.+totaldOf :: LaTeXC l => l -> l+totaldOf v = mathrm "d" <> v  ---- Operator symbols