[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] Add Pandoc (and whatever it needs)
From: |
Ludovic Courtès |
Subject: |
Re: [PATCH] Add Pandoc (and whatever it needs) |
Date: |
Wed, 09 Dec 2015 22:36:38 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/24.5 (gnu/linux) |
Ricardo Wurmus <address@hidden> skribis:
> this is the second batch of Haskell packages we need to have a Pandoc
> package. These patches apply after the other patch set I sent to the ML
> yesterday.
Impressive (and intimidating) amount of work!
I skimmed over the list of packages, which look good to me. Just a few
random cosmetic comments:
> + (home-page "http://github.com/snoyberg/yaml/")
> + (synopsis "Support for parsing and rendering YAML documents")
Maybe “Parsing and rendering YAML documents”?
> + (description
> + "This library provides a wrapper to mmap, allowing files or devices to
> be
> +lazily loaded into memory as strict or lazy ByteStrings, ForeignPtrs or plain
> +Ptrs, using the virtual memory subsystem to do on-demand loading.")
Could use @code for data types.
> + (description
> + "This library can load and store images in PNG, Bitmap, Jpeg, Radiance,
> +Tiff and Gif formats.")
JPEG, TIFF, GIF (all caps.)
> + (home-page "http://hackage.haskell.org/package/SHA")
> + (synopsis "Implementations of the SHA suite of message digest functions")
s/Implementations of the //g
> + (home-page "https://github.com/yesodweb/wai")
> + (synopsis "Basic mime-type handling types and functions")
> + (description
> + "This library provides basic mime-type handling types and functions.")
“MIME type.”
> + (home-page "http://github.com/vincenthz/hs-pem")
> + (synopsis "Privacy Enhanced Mail (PEM) format reader and writer.")
Remove period.
> + (home-page "http://github.com/vincenthz/hs-asn1-types")
> + (synopsis "ASN.1 types for Haskell")
> + (description
> + "The packaga provides the standard types for dealing with the ASN.1
^
Typo.
> + (home-page "https://github.com/haskell-crypto/cryptonite")
> + (synopsis "Cryptography primitives")
> + (description
> + "This package is a repository of cryptographic primitives for Haskell.
> +It strives to be a cryptographic kitchen sink that provides cryptography for
> +everyone.
> +
> +Supported symmetric ciphers: AES, DES, 3DES, Blowfish, Camellia, RC4, Salsa,
> +ChaCha; supported hash functions: SHA1, SHA2, SHA3, MD2, MD4, MD5, Keccak,
> +Skein, Ripemd, Tiger, Whirlpool, Blake2; MAC: HMAC, Poly1305; assymmetric
> +crypto: DSA, RSA, DH, ECDH, ECDSA, ECC, Curve25519, Ed25519; key derivation
> +functions: PBKDF2, Scrypt; cryptographic random number generation: system
> +entropy, deterministic random generator; data-related features:
> address@hidden information splitter} (AFIS).")
What about something like “It supports a wide range of symmetric
ciphers, cryptographic hash functions, public key algorithms, key
derivation numbers, cryptographic random number generators, and more.”?
> + (home-page "http://github.com/vincenthz/hs-tls")
> + (synopsis
> + "TLS/SSL protocol native implementation (Server and Client)")
> + (description
> + "Native Haskell TLS and SSL protocol implementation for server and
> client. . This provides a high-level implementation of a sensitive security
> protocol, eliminating a common set of security issues through the use of the
> advanced type system, high level constructions and common Haskell features. .
> Currently implement the SSL3.0, TLS1.0, TLS1.1 and TLS1.2 protocol, and
> support RSA and Ephemeral (Elliptic curve and regular) Diffie Hellman key
> exchanges, and many extensions. . Some debug tools linked with tls, are
> available through the <http://hackage.haskell.org/package/tls-debug/>.")
Could you wrap it, remove extra periods, and use @url?
> + (home-page "http://pandoc.org")
> + (synopsis "Conversion between markup formats")
> + (description
> + "Pandoc is a Haskell library for converting from one markup format to
> +another, and a command-line tool that uses this library. It can read
> markdown
> +and (subsets of) HTML, reStructuredText, LaTeX, DocBook, MediaWiki markup,
> +TWiki markup, Haddock markup, OPML, Emacs Org-Mode, txt2tags, Word Docx, ODT,
> +and Textile, and it can write Markdown, reStructuredText, XHTML, HTML 5,
> +LaTeX, ConTeXt, DocBook, OPML, OpenDocument, ODT, Word docx, RTF, MediaWiki,
> +DokuWiki, Textile, groff man pages, plain text, Emacs Org-Mode, AsciiDoc,
> +Haddock markup, EPUB (v2 and v3), FictionBook2, InDesign ICML, and several
> +kinds of HTML/javascript slide shows (S5, Slidy, Slideous, DZSlides,
> +reveal.js).
> +
> +Pandoc extends standard markdown syntax with footnotes, embedded LaTeX,
> +definition lists, tables, and other features. A compatibility mode is
> +provided for those who need a drop-in replacement for Markdown.pl. In
> +contrast to existing tools for converting markdown to HTML, which use regex
> +substitutions, pandoc has a modular design: it consists of a set of readers,
> +which parse text in a given format and produce a native representation of the
> +document, and a set of writers, which convert this native representation into
> +a target format. Thus, adding an input or output format requires only adding
> +a reader or writer.")
Would be nice to keep just one third of it, notably by omitting the list
of supported formats. :-)
I think it’s OK to commit with these changes. I hope it’s not too
painful to apply them.
Thank you!
Ludo’.
- Re: [PATCH] Add Pandoc (and whatever it needs),
Ludovic Courtès <=