<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/Text/CSL.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-2"></a><span class='hs-comment'>-- |</span>
<a name="line-3"></a><span class='hs-comment'>-- Module : Text.CSL</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Andrea Rossato</span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD-style (see LICENSE)</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : Andrea Rossato <andrea.rossato@unitn.it></span>
<a name="line-8"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-9"></a><span class='hs-comment'>-- Portability : unportable</span>
<a name="line-10"></a><span class='hs-comment'>--</span>
<a name="line-11"></a><span class='hs-comment'>-- /citeproc-hs/ is a library for automatically formatting</span>
<a name="line-12"></a><span class='hs-comment'>-- bibliographic reference citations into a variety of styles using a</span>
<a name="line-13"></a><span class='hs-comment'>-- macro language called Citation Style Language (CSL). More details</span>
<a name="line-14"></a><span class='hs-comment'>-- on CSL can be found here: <<a href="http://citationstyles.org/">http://citationstyles.org/</a>>.</span>
<a name="line-15"></a><span class='hs-comment'>--</span>
<a name="line-16"></a><span class='hs-comment'>-- This module documents and exports the library API.</span>
<a name="line-17"></a><span class='hs-comment'>--</span>
<a name="line-18"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-19"></a>
<a name="line-20"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>CSL</span>
<a name="line-21"></a> <span class='hs-layout'>(</span> <span class='hs-comment'>-- * Introduction</span>
<a name="line-22"></a> <span class='hs-comment'>-- $intro</span>
<a name="line-23"></a>
<a name="line-24"></a> <span class='hs-comment'>-- * Overview: A Simple Example</span>
<a name="line-25"></a> <span class='hs-comment'>-- $overview</span>
<a name="line-26"></a>
<a name="line-27"></a> <span class='hs-comment'>-- * Reading Bibliographic Databases</span>
<a name="line-28"></a> <span class='hs-varid'>readBiblioFile</span>
<a name="line-29"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>readModsFile</span>
<a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>readModsCollectionFile</span>
<a name="line-31"></a>
<a name="line-32"></a> <span class='hs-comment'>-- ** Reference Representation</span>
<a name="line-33"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Reference</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-34"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>getReference</span>
<a name="line-35"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>parseLocator</span>
<a name="line-36"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>setNearNote</span>
<a name="line-37"></a>
<a name="line-38"></a> <span class='hs-comment'>-- * CSL Parser, Representation, and Processing</span>
<a name="line-39"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>readCSLFile</span>
<a name="line-40"></a>
<a name="line-41"></a> <span class='hs-comment'>-- ** The Style Types</span>
<a name="line-42"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Style</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-43"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Citation</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-44"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Bibliography</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-45"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Cite</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-46"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Affix</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-47"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>emptyCite</span>
<a name="line-48"></a>
<a name="line-49"></a> <span class='hs-comment'>-- ** High Level Processing</span>
<a name="line-50"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ProcOpts</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-51"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>procOpts</span>
<a name="line-52"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>BibOpts</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-53"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>citeproc</span>
<a name="line-54"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>processCitations</span>
<a name="line-55"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>processBibliography</span>
<a name="line-56"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>BiblioData</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-57"></a>
<a name="line-58"></a> <span class='hs-comment'>-- * The output and the rendering functions</span>
<a name="line-59"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>FormattedOutput</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-60"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>renderPlain</span>
<a name="line-61"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>renderPlainStrict</span>
<a name="line-62"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>renderPandoc</span>
<a name="line-63"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>renderPandoc'</span>
<a name="line-64"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>headInline</span>
<a name="line-65"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>initInline</span>
<a name="line-66"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>tailFirstInlineStr</span>
<a name="line-67"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>toCapital</span>
<a name="line-68"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>startWithPunct</span>
<a name="line-69"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>endWithPunct</span>
<a name="line-70"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-71"></a>
<a name="line-72"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>CSL</span><span class='hs-varop'>.</span><span class='hs-conid'>Parser</span>
<a name="line-73"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>CSL</span><span class='hs-varop'>.</span><span class='hs-conid'>Proc</span>
<a name="line-74"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>CSL</span><span class='hs-varop'>.</span><span class='hs-conid'>Reference</span>
<a name="line-75"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>CSL</span><span class='hs-varop'>.</span><span class='hs-conid'>Style</span>
<a name="line-76"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>CSL</span><span class='hs-varop'>.</span><span class='hs-conid'>Input</span><span class='hs-varop'>.</span><span class='hs-conid'>Bibutils</span>
<a name="line-77"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>CSL</span><span class='hs-varop'>.</span><span class='hs-conid'>Input</span><span class='hs-varop'>.</span><span class='hs-conid'>MODS</span>
<a name="line-78"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>CSL</span><span class='hs-varop'>.</span><span class='hs-conid'>Output</span><span class='hs-varop'>.</span><span class='hs-conid'>Pandoc</span>
<a name="line-79"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>CSL</span><span class='hs-varop'>.</span><span class='hs-conid'>Output</span><span class='hs-varop'>.</span><span class='hs-conid'>Plain</span>
<a name="line-80"></a>
<a name="line-81"></a>
<a name="line-82"></a><span class='hs-comment'>-- $intro</span>
<a name="line-83"></a><span class='hs-comment'>--</span>
<a name="line-84"></a><span class='hs-comment'>-- /citeproc-hs/ provides functions for reading bibliographic</span>
<a name="line-85"></a><span class='hs-comment'>-- databases, for reading and parsing CSL files and for generating</span>
<a name="line-86"></a><span class='hs-comment'>-- citations in an internal format, 'FormattedOutput', that can be</span>
<a name="line-87"></a><span class='hs-comment'>-- easily rendered into different final formats. At the present time</span>
<a name="line-88"></a><span class='hs-comment'>-- only 'Pandoc' and plain text rendering functions are provided by</span>
<a name="line-89"></a><span class='hs-comment'>-- the library.</span>
<a name="line-90"></a><span class='hs-comment'>--</span>
<a name="line-91"></a><span class='hs-comment'>-- The library also provides a wrapper around hs-bibutils, the Haskell</span>
<a name="line-92"></a><span class='hs-comment'>-- bindings to Chris Putnam's bibutils, a library that interconverts</span>
<a name="line-93"></a><span class='hs-comment'>-- between various bibliography formats using a common MODS-format XML</span>
<a name="line-94"></a><span class='hs-comment'>-- intermediate. For more information about hs-bibutils see here:</span>
<a name="line-95"></a><span class='hs-comment'>-- <<a href="http://code.haskell.org/hs-bibutils/">http://code.haskell.org/hs-bibutils/</a>>.</span>
<a name="line-96"></a><span class='hs-comment'>--</span>
<a name="line-97"></a><span class='hs-comment'>-- /citeproc-hs/ can natively read MODS and JSON formatted</span>
<a name="line-98"></a><span class='hs-comment'>-- bibliographic databases. The JSON format is only partially</span>
<a name="line-99"></a><span class='hs-comment'>-- documented. It is used by citeproc-js, by the CSL processor</span>
<a name="line-100"></a><span class='hs-comment'>-- test-suite and is derived by the CSL scheme. More information can</span>
<a name="line-101"></a><span class='hs-comment'>-- be read here:</span>
<a name="line-102"></a><span class='hs-comment'>-- <<a href="http://citationstyles.org/">http://citationstyles.org/</a>>.</span>
<a name="line-103"></a><span class='hs-comment'>--</span>
<a name="line-104"></a><span class='hs-comment'>-- A (git) repository of styles can be found here:</span>
<a name="line-105"></a><span class='hs-comment'>-- <https://github.com/citation-style-language/styles>.</span>
<a name="line-106"></a>
<a name="line-107"></a><span class='hs-comment'>-- $overview</span>
<a name="line-108"></a><span class='hs-comment'>--</span>
<a name="line-109"></a><span class='hs-comment'>-- The following example assumes you have installed citeproc-hs with</span>
<a name="line-110"></a><span class='hs-comment'>-- hs-bibutils support (which is the default).</span>
<a name="line-111"></a><span class='hs-comment'>--</span>
<a name="line-112"></a><span class='hs-comment'>-- Suppose you have a small bibliographic database, like this one:</span>
<a name="line-113"></a><span class='hs-comment'>--</span>
<a name="line-114"></a><span class='hs-comment'>-- > @Book{Rossato2006,</span>
<a name="line-115"></a><span class='hs-comment'>-- > author="Andrea Rossato",</span>
<a name="line-116"></a><span class='hs-comment'>-- > title="My Second Book",</span>
<a name="line-117"></a><span class='hs-comment'>-- > year="2006"</span>
<a name="line-118"></a><span class='hs-comment'>-- > }</span>
<a name="line-119"></a><span class='hs-comment'>-- ></span>
<a name="line-120"></a><span class='hs-comment'>-- > @Book{Caso2007,</span>
<a name="line-121"></a><span class='hs-comment'>-- > author="Roberto Caso",</span>
<a name="line-122"></a><span class='hs-comment'>-- > title="Roberto's Book",</span>
<a name="line-123"></a><span class='hs-comment'>-- > year="2007"</span>
<a name="line-124"></a><span class='hs-comment'>-- > }</span>
<a name="line-125"></a><span class='hs-comment'>--</span>
<a name="line-126"></a><span class='hs-comment'>-- Save it as @mybibdb.bib@.</span>
<a name="line-127"></a><span class='hs-comment'>--</span>
<a name="line-128"></a><span class='hs-comment'>-- Then you can grab one of the CSL styles that come with the</span>
<a name="line-129"></a><span class='hs-comment'>-- test-suite for CSL processors. Suppose this one:</span>
<a name="line-130"></a><span class='hs-comment'>--</span>
<a name="line-131"></a><span class='hs-comment'>-- <https://bitbucket.org/bdarcus/citeproc-test/raw/18141149d1d3/styles/apa-x.csl></span>
<a name="line-132"></a><span class='hs-comment'>--</span>
<a name="line-133"></a><span class='hs-comment'>-- saved locally as @apa-x.csl@.</span>
<a name="line-134"></a><span class='hs-comment'>--</span>
<a name="line-135"></a><span class='hs-comment'>-- This would be a simple program that formats a list of citations</span>
<a name="line-136"></a><span class='hs-comment'>-- according to that style:</span>
<a name="line-137"></a><span class='hs-comment'>--</span>
<a name="line-138"></a><span class='hs-comment'>-- > import Text.CSL</span>
<a name="line-139"></a><span class='hs-comment'>-- ></span>
<a name="line-140"></a><span class='hs-comment'>-- > cites :: [Cite]</span>
<a name="line-141"></a><span class='hs-comment'>-- > cites = [emptyCite { citeId = "Caso2007"</span>
<a name="line-142"></a><span class='hs-comment'>-- > , citeLabel = "page"</span>
<a name="line-143"></a><span class='hs-comment'>-- > , citeLocator = "15"}</span>
<a name="line-144"></a><span class='hs-comment'>-- > ,emptyCite { citeId = "Rossato2006"</span>
<a name="line-145"></a><span class='hs-comment'>-- > , citeLabel = "page"</span>
<a name="line-146"></a><span class='hs-comment'>-- > , citeLocator = "10"}</span>
<a name="line-147"></a><span class='hs-comment'>-- > ]</span>
<a name="line-148"></a><span class='hs-comment'>-- ></span>
<a name="line-149"></a><span class='hs-comment'>-- > main :: IO ()</span>
<a name="line-150"></a><span class='hs-comment'>-- > main = do</span>
<a name="line-151"></a><span class='hs-comment'>-- > m <- readBiblioFile "mybibdb.bib"</span>
<a name="line-152"></a><span class='hs-comment'>-- > s <- readCSLFile "apa-x.csl"</span>
<a name="line-153"></a><span class='hs-comment'>-- > let result = citeproc procOpts s m $ [cites]</span>
<a name="line-154"></a><span class='hs-comment'>-- > putStrLn . unlines . map (renderPlainStrict) . citations $ result</span>
<a name="line-155"></a><span class='hs-comment'>--</span>
<a name="line-156"></a><span class='hs-comment'>-- The result would be:</span>
<a name="line-157"></a><span class='hs-comment'>--</span>
<a name="line-158"></a><span class='hs-comment'>-- > (Caso, 2007, p. 15; Rossato, 2006, p. 10)</span>
</pre></body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
985645091e820b64b6dd8f6fff6fd68e
>
files
>
140
