Files F2718200

No OneTemporary
Actions

File Metadata

Created
Sun, Feb 15, 5:14 PM

View Options

diff --git a/documentation-tools/doc-converter/DocBook.hs b/documentation-tools/doc-converter/DocBook.hs
index 151ae0c..e4bd766 100644
--- a/documentation-tools/doc-converter/DocBook.hs
+++ b/documentation-tools/doc-converter/DocBook.hs
@@ -1,1127 +1,1133 @@
{-# LANGUAGE NoImplicitPrelude #-}
{-
Copyright (C) 2006-2018 John MacFarlane <jgm@berkeley.edu>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-}
{- |
Module : Text.Pandoc.Readers.DocBook
Copyright : Copyright (C) 2006-2018 John MacFarlane
License : GNU GPL, version 2 or above
Maintainer : John MacFarlane <jgm@berkeley.edu>
Stability : alpha
Portability : portable
Conversion of DocBook XML to 'Pandoc' document.
-}
module Text.Pandoc.Readers.DocBook ( readDocBook ) where
import Prelude
import Control.Monad.State.Strict
import Data.Char (isSpace, toUpper)
import Data.Default
import Data.Either (rights)
import Data.Foldable (asum)
import Data.Generics
import Data.List (intersperse)
import Data.Maybe (fromMaybe)
import Data.Text (Text)
import qualified Data.Text as T
import Text.HTML.TagSoup.Entity (lookupEntity)
import Text.Pandoc.Builder
import Text.Pandoc.Class (PandocMonad)
import Text.Pandoc.Options
import Text.Pandoc.Shared (crFilter, safeRead)
import Text.TeXMath (readMathML, writeTeX)
import Text.XML.Light
{-
List of all DocBook tags, with [x] indicating implemented,
[o] meaning intentionally left unimplemented (pass through):
[o] abbrev - An abbreviation, especially one followed by a period
[x] abstract - A summary
[o] accel - A graphical user interface (GUI) keyboard shortcut
[x] ackno - Acknowledgements in an Article
[o] acronym - An often pronounceable word made from the initial
[o] action - A response to a user event
[o] address - A real-world address, generally a postal address
[ ] affiliation - The institutional affiliation of an individual
[ ] alt - Text representation for a graphical element
[o] anchor - A spot in the document
[x] answer - An answer to a question posed in a QandASet
[x] appendix - An appendix in a Book or Article
[x] appendixinfo - Meta-information for an Appendix
[o] application - The name of a software program
[x] area - A region defined for a Callout in a graphic or code example
[x] areaset - A set of related areas in a graphic or code example
[x] areaspec - A collection of regions in a graphic or code example
[ ] arg - An argument in a CmdSynopsis
[x] article - An article
[x] articleinfo - Meta-information for an Article
[ ] artpagenums - The page numbers of an article as published
[x] attribution - The source of a block quote or epigraph
[ ] audiodata - Pointer to external audio data
[ ] audioobject - A wrapper for audio data and its associated meta-information
[x] author - The name of an individual author
[ ] authorblurb - A short description or note about an author
[x] authorgroup - Wrapper for author information when a document has
multiple authors or collaborators
[x] authorinitials - The initials or other short identifier for an author
[o] beginpage - The location of a page break in a print version of the document
[ ] bibliocoverage - The spatial or temporal coverage of a document
[x] bibliodiv - A section of a Bibliography
[x] biblioentry - An entry in a Bibliography
[x] bibliography - A bibliography
[ ] bibliographyinfo - Meta-information for a Bibliography
[ ] biblioid - An identifier for a document
[o] bibliolist - A wrapper for a set of bibliography entries
[ ] bibliomisc - Untyped bibliographic information
[x] bibliomixed - An entry in a Bibliography
[ ] bibliomset - A cooked container for related bibliographic information
[ ] biblioref - A cross reference to a bibliographic entry
[ ] bibliorelation - The relationship of a document to another
[ ] biblioset - A raw container for related bibliographic information
[ ] bibliosource - The source of a document
[ ] blockinfo - Meta-information for a block element
[x] blockquote - A quotation set off from the main text
[x] book - A book
[x] bookinfo - Meta-information for a Book
[x] bridgehead - A free-floating heading
[x] callout - A “called out” description of a marked Area
[x] calloutlist - A list of Callouts
[x] caption - A caption
[x] caution - A note of caution
[x] chapter - A chapter, as of a book
[x] chapterinfo - Meta-information for a Chapter
[ ] citation - An inline bibliographic reference to another published work
[ ] citebiblioid - A citation of a bibliographic identifier
[ ] citerefentry - A citation to a reference page
[ ] citetitle - The title of a cited work
[ ] city - The name of a city in an address
[x] classname - The name of a class, in the object-oriented programming sense
[ ] classsynopsis - The syntax summary for a class definition
[ ] classsynopsisinfo - Information supplementing the contents of
a ClassSynopsis
[ ] cmdsynopsis - A syntax summary for a software command
[ ] co - The location of a callout embedded in text
[x] code - An inline code fragment
[x] col - Specifications for a column in an HTML table
[x] colgroup - A group of columns in an HTML table
[ ] collab - Identifies a collaborator
[ ] collabname - The name of a collaborator
[ ] colophon - Text at the back of a book describing facts about its production
[x] colspec - Specifications for a column in a table
[x] command - The name of an executable program or other software command
[x] computeroutput - Data, generally text, displayed or presented by a computer
[ ] confdates - The dates of a conference for which a document was written
[ ] confgroup - A wrapper for document meta-information about a conference
[ ] confnum - An identifier, frequently numerical, associated with a conference for which a document was written
[ ] confsponsor - The sponsor of a conference for which a document was written
[ ] conftitle - The title of a conference for which a document was written
[x] constant - A programming or system constant
[ ] constraint - A constraint in an EBNF production
[ ] constraintdef - The definition of a constraint in an EBNF production
[ ] constructorsynopsis - A syntax summary for a constructor
[ ] contractnum - The contract number of a document
[ ] contractsponsor - The sponsor of a contract
[ ] contrib - A summary of the contributions made to a document by a
credited source
[ ] copyright - Copyright information about a document
[ ] coref - A cross reference to a co
[ ] corpauthor - A corporate author, as opposed to an individual
[ ] corpcredit - A corporation or organization credited in a document
[ ] corpname - The name of a corporation
[ ] country - The name of a country
[ ] database - The name of a database, or part of a database
[x] date - The date of publication or revision of a document
[ ] dedication - A wrapper for the dedication section of a book
[ ] destructorsynopsis - A syntax summary for a destructor
[ ] edition - The name or number of an edition of a document
[ ] editor - The name of the editor of a document
[x] email - An email address
[x] emphasis - Emphasized text
[x] entry - A cell in a table
[ ] entrytbl - A subtable appearing in place of an Entry in a table
[ ] envar - A software environment variable
[x] epigraph - A short inscription at the beginning of a document or component
note: also handle embedded attribution tag
[x] equation - A displayed mathematical equation
[ ] errorcode - An error code
[ ] errorname - An error name
[ ] errortext - An error message.
[ ] errortype - The classification of an error message
[ ] example - A formal example, with a title
[ ] exceptionname - The name of an exception
[ ] fax - A fax number
[ ] fieldsynopsis - The name of a field in a class definition
[x] figure - A formal figure, generally an illustration, with a title
[x] filename - The name of a file
[ ] firstname - The first name of a person
[ ] firstterm - The first occurrence of a term
[x] footnote - A footnote
[ ] footnoteref - A cross reference to a footnote (a footnote mark)
[x] foreignphrase - A word or phrase in a language other than the primary
language of the document
[x] formalpara - A paragraph with a title
[ ] funcdef - A function (subroutine) name and its return type
[ ] funcparams - Parameters for a function referenced through a function
pointer in a synopsis
[ ] funcprototype - The prototype of a function
[ ] funcsynopsis - The syntax summary for a function definition
[ ] funcsynopsisinfo - Information supplementing the FuncDefs of a FuncSynopsis
[x] function - The name of a function or subroutine, as in a
programming language
[x] glossary - A glossary
[x] glossaryinfo - Meta-information for a Glossary
[x] glossdef - A definition in a GlossEntry
[x] glossdiv - A division in a Glossary
[x] glossentry - An entry in a Glossary or GlossList
[x] glosslist - A wrapper for a set of GlossEntrys
[x] glosssee - A cross-reference from one GlossEntry to another
[x] glossseealso - A cross-reference from one GlossEntry to another
[x] glossterm - A glossary term
[ ] graphic - A displayed graphical object (not an inline)
Note: in DocBook v5 `graphic` is discarded
[ ] graphicco - A graphic that contains callout areas
Note: in DocBook v5 `graphicco` is discarded
[ ] group - A group of elements in a CmdSynopsis
[ ] guibutton - The text on a button in a GUI
[ ] guiicon - Graphic and/or text appearing as a icon in a GUI
[ ] guilabel - The text of a label in a GUI
[x] guimenu - The name of a menu in a GUI
[x] guimenuitem - The name of a terminal menu item in a GUI
[x] guisubmenu - The name of a submenu in a GUI
[ ] hardware - A physical part of a computer system
[ ] highlights - A summary of the main points of the discussed component
[ ] holder - The name of the individual or organization that holds a copyright
[o] honorific - The title of a person
[ ] html:form - An HTML form
[x] imagedata - Pointer to external image data (only `fileref` attribute
implemented but not `entityref` which would require parsing of the DTD)
[x] imageobject - A wrapper for image data and its associated meta-information
[ ] imageobjectco - A wrapper for an image object with callouts
[x] important - An admonition set off from the text
[x] index - An index
[x] indexdiv - A division in an index
[x] indexentry - An entry in an index
[x] indexinfo - Meta-information for an Index
[x] indexterm - A wrapper for terms to be indexed
[x] info - A wrapper for information about a component or other block. (DocBook v5)
[x] informalequation - A displayed mathematical equation without a title
[x] informalexample - A displayed example without a title
[ ] informalfigure - A untitled figure
[ ] informaltable - A table without a title
[ ] initializer - The initializer for a FieldSynopsis
[x] inlineequation - A mathematical equation or expression occurring inline
[ ] inlinegraphic - An object containing or pointing to graphical data
that will be rendered inline
[x] inlinemediaobject - An inline media object (video, audio, image, and so on)
[ ] interface - An element of a GUI
[ ] interfacename - The name of an interface
[ ] invpartnumber - An inventory part number
[ ] isbn - The International Standard Book Number of a document
[ ] issn - The International Standard Serial Number of a periodical
[ ] issuenum - The number of an issue of a journal
[x] itemizedlist - A list in which each entry is marked with a bullet or
other dingbat
[ ] itermset - A set of index terms in the meta-information of a document
[ ] jobtitle - The title of an individual in an organization
[x] keycap - The text printed on a key on a keyboard
[ ] keycode - The internal, frequently numeric, identifier for a key
on a keyboard
[x] keycombo - A combination of input actions
[ ] keysym - The symbolic name of a key on a keyboard
[ ] keyword - One of a set of keywords describing the content of a document
[ ] keywordset - A set of keywords describing the content of a document
[ ] label - A label on a Question or Answer
[ ] legalnotice - A statement of legal obligations or requirements
[ ] lhs - The left-hand side of an EBNF production
[ ] lineage - The portion of a person's name indicating a relationship to
ancestors
[ ] lineannotation - A comment on a line in a verbatim listing
[x] link - A hypertext link
[x] listitem - A wrapper for the elements of a list item
[x] literal - Inline text that is some literal value
[x] literallayout - A block of text in which line breaks and white space are
to be reproduced faithfully
[ ] lot - A list of the titles of formal objects (as tables or figures) in
a document
[ ] lotentry - An entry in a list of titles
[ ] manvolnum - A reference volume number
[x] markup - A string of formatting markup in text that is to be
represented literally
[x] mathphrase - A mathematical phrase, an expression that can be represented
with ordinary text and a small amount of markup
[ ] medialabel - A name that identifies the physical medium on which some
information resides
[x] mediaobject - A displayed media object (video, audio, image, etc.)
[ ] mediaobjectco - A media object that contains callouts
[x] member - An element of a simple list
[x] menuchoice - A selection or series of selections from a menu
[ ] methodname - The name of a method
[ ] methodparam - Parameters to a method
[ ] methodsynopsis - A syntax summary for a method
[x] mml:math - A MathML equation
[ ] modespec - Application-specific information necessary for the
completion of an OLink
[ ] modifier - Modifiers in a synopsis
[ ] mousebutton - The conventional name of a mouse button
[ ] msg - A message in a message set
[ ] msgaud - The audience to which a message in a message set is relevant
[ ] msgentry - A wrapper for an entry in a message set
[ ] msgexplan - Explanatory material relating to a message in a message set
[ ] msginfo - Information about a message in a message set
[ ] msglevel - The level of importance or severity of a message in a message set
[ ] msgmain - The primary component of a message in a message set
[ ] msgorig - The origin of a message in a message set
[ ] msgrel - A related component of a message in a message set
[ ] msgset - A detailed set of messages, usually error messages
[ ] msgsub - A subcomponent of a message in a message set
[ ] msgtext - The actual text of a message component in a message set
[ ] nonterminal - A non-terminal in an EBNF production
[x] note - A message set off from the text
[ ] objectinfo - Meta-information for an object
[ ] olink - A link that addresses its target indirectly, through an entity
[ ] ooclass - A class in an object-oriented programming language
[ ] ooexception - An exception in an object-oriented programming language
[ ] oointerface - An interface in an object-oriented programming language
[x] option - An option for a software command
[x] optional - Optional information
[x] orderedlist - A list in which each entry is marked with a sequentially
incremented label
[ ] orgdiv - A division of an organization
[ ] orgname - The name of an organization other than a corporation
[ ] otheraddr - Uncategorized information in address
[ ] othercredit - A person or entity, other than an author or editor,
credited in a document
[ ] othername - A component of a persons name that is not a first name,
surname, or lineage
[ ] package - A package
[ ] pagenums - The numbers of the pages in a book, for use in a bibliographic
entry
[x] para - A paragraph
[ ] paramdef - Information about a function parameter in a programming language
[x] parameter - A value or a symbolic reference to a value
[ ] part - A division in a book
[ ] partinfo - Meta-information for a Part
[ ] partintro - An introduction to the contents of a part
[ ] personblurb - A short description or note about a person
[ ] personname - The personal name of an individual
[ ] phone - A telephone number
[ ] phrase - A span of text
[ ] pob - A post office box in an address
[ ] postcode - A postal code in an address
[x] preface - Introductory matter preceding the first chapter of a book
[ ] prefaceinfo - Meta-information for a Preface
[ ] primary - The primary word or phrase under which an index term should be
sorted
[ ] primaryie - A primary term in an index entry, not in the text
[ ] printhistory - The printing history of a document
[ ] procedure - A list of operations to be performed in a well-defined sequence
[ ] production - A production in a set of EBNF productions
[ ] productionrecap - A cross-reference to an EBNF production
[ ] productionset - A set of EBNF productions
[ ] productname - The formal name of a product
[ ] productnumber - A number assigned to a product
[x] programlisting - A literal listing of all or part of a program
[ ] programlistingco - A program listing with associated areas used in callouts
[x] prompt - A character or string indicating the start of an input field in
a computer display
[ ] property - A unit of data associated with some part of a computer system
[ ] pubdate - The date of publication of a document
[ ] publisher - The publisher of a document
[ ] publishername - The name of the publisher of a document
[ ] pubsnumber - A number assigned to a publication other than an ISBN or ISSN
or inventory part number
[x] qandadiv - A titled division in a QandASet
[o] qandaentry - A question/answer set within a QandASet
[o] qandaset - A question-and-answer set
[x] question - A question in a QandASet
[x] quote - An inline quotation
[ ] refclass - The scope or other indication of applicability of a
reference entry
[ ] refdescriptor - A description of the topic of a reference page
[ ] refentry - A reference page (originally a UNIX man-style reference page)
[ ] refentryinfo - Meta-information for a Refentry
[ ] refentrytitle - The title of a reference page
[ ] reference - A collection of reference entries
[ ] referenceinfo - Meta-information for a Reference
[ ] refmeta - Meta-information for a reference entry
[ ] refmiscinfo - Meta-information for a reference entry other than the title
and volume number
[ ] refname - The name of (one of) the subject(s) of a reference page
[ ] refnamediv - The name, purpose, and classification of a reference page
[ ] refpurpose - A short (one sentence) synopsis of the topic of a reference
page
[x] refsect1 - A major subsection of a reference entry
[x] refsect1info - Meta-information for a RefSect1
[x] refsect2 - A subsection of a RefSect1
[x] refsect2info - Meta-information for a RefSect2
[x] refsect3 - A subsection of a RefSect2
[x] refsect3info - Meta-information for a RefSect3
[x] refsection - A recursive section in a refentry
[x] refsectioninfo - Meta-information for a refsection
[ ] refsynopsisdiv - A syntactic synopsis of the subject of the reference page
[ ] refsynopsisdivinfo - Meta-information for a RefSynopsisDiv
[x] releaseinfo - Information about a particular release of a document
[ ] remark - A remark (or comment) intended for presentation in a draft
manuscript
[ ] replaceable - Content that may or must be replaced by the user
[ ] returnvalue - The value returned by a function
[ ] revdescription - A extended description of a revision to a document
[ ] revhistory - A history of the revisions to a document
[ ] revision - An entry describing a single revision in the history of the
revisions to a document
[ ] revnumber - A document revision number
[ ] revremark - A description of a revision to a document
[ ] rhs - The right-hand side of an EBNF production
[x] row - A row in a table
[ ] sbr - An explicit line break in a command synopsis
[x] screen - Text that a user sees or might see on a computer screen
[o] screenco - A screen with associated areas used in callouts
[o] screeninfo - Information about how a screen shot was produced
[ ] screenshot - A representation of what the user sees or might see on a
computer screen
[ ] secondary - A secondary word or phrase in an index term
[ ] secondaryie - A secondary term in an index entry, rather than in the text
[x] sect1 - A top-level section of document
[x] sect1info - Meta-information for a Sect1
[x] sect2 - A subsection within a Sect1
[x] sect2info - Meta-information for a Sect2
[x] sect3 - A subsection within a Sect2
[x] sect3info - Meta-information for a Sect3
[x] sect4 - A subsection within a Sect3
[x] sect4info - Meta-information for a Sect4
[x] sect5 - A subsection within a Sect4
[x] sect5info - Meta-information for a Sect5
[x] section - A recursive section
[x] sectioninfo - Meta-information for a recursive section
[x] see - Part of an index term directing the reader instead to another entry
in the index
[x] seealso - Part of an index term directing the reader also to another entry
in the index
[ ] seealsoie - A See also entry in an index, rather than in the text
[ ] seeie - A See entry in an index, rather than in the text
[x] seg - An element of a list item in a segmented list
[x] seglistitem - A list item in a segmented list
[x] segmentedlist - A segmented list, a list of sets of elements
[x] segtitle - The title of an element of a list item in a segmented list
[ ] seriesvolnums - Numbers of the volumes in a series of books
[ ] set - A collection of books
[ ] setindex - An index to a set of books
[ ] setindexinfo - Meta-information for a SetIndex
[ ] setinfo - Meta-information for a Set
[ ] sgmltag - A component of SGML markup
[ ] shortaffil - A brief description of an affiliation
[ ] shortcut - A key combination for an action that is also accessible through
a menu
[ ] sidebar - A portion of a document that is isolated from the main
narrative flow
[ ] sidebarinfo - Meta-information for a Sidebar
[x] simpara - A paragraph that contains only text and inline markup, no block
elements
[x] simplelist - An undecorated list of single words or short phrases
[ ] simplemsgentry - A wrapper for a simpler entry in a message set
[ ] simplesect - A section of a document with no subdivisions
[ ] spanspec - Formatting information for a spanned column in a table
[ ] state - A state or province in an address
[ ] step - A unit of action in a procedure
[ ] stepalternatives - Alternative steps in a procedure
[ ] street - A street address in an address
[ ] structfield - A field in a structure (in the programming language sense)
[ ] structname - The name of a structure (in the programming language sense)
[ ] subject - One of a group of terms describing the subject matter of a
document
[ ] subjectset - A set of terms describing the subject matter of a document
[ ] subjectterm - A term in a group of terms describing the subject matter of
a document
[x] subscript - A subscript (as in H2O, the molecular formula for water)
[ ] substeps - A wrapper for steps that occur within steps in a procedure
[x] subtitle - The subtitle of a document
[x] superscript - A superscript (as in x2, the mathematical notation for x
multiplied by itself)
[ ] surname - A family name; in western cultures the last name
[ ] svg:svg - An SVG graphic
[x] symbol - A name that is replaced by a value before processing
[ ] synopfragment - A portion of a CmdSynopsis broken out from the main body
of the synopsis
[ ] synopfragmentref - A reference to a fragment of a command synopsis
[ ] synopsis - A general-purpose element for representing the syntax of
commands or functions
[ ] systemitem - A system-related item or term
[ ] table - A formal table in a document
[ ] task - A task to be completed
[ ] taskprerequisites - The prerequisites for a task
[ ] taskrelated - Information related to a task
[ ] tasksummary - A summary of a task
[x] tbody - A wrapper for the rows of a table or informal table
[x] td - A table entry in an HTML table
[x] term - The word or phrase being defined or described in a variable list
[ ] termdef - An inline term definition
[ ] tertiary - A tertiary word or phrase in an index term
[ ] tertiaryie - A tertiary term in an index entry, rather than in the text
[ ] textdata - Pointer to external text data
[ ] textobject - A wrapper for a text description of an object and its
associated meta-information
[ ] tfoot - A table footer consisting of one or more rows
[x] tgroup - A wrapper for the main content of a table, or part of a table
[x] th - A table header entry in an HTML table
[x] thead - A table header consisting of one or more rows
[x] tip - A suggestion to the user, set off from the text
[x] title - The text of the title of a section of a document or of a formal
block-level element
[x] titleabbrev - The abbreviation of a Title
[x] toc - A table of contents
[x] tocback - An entry in a table of contents for a back matter component
[x] tocchap - An entry in a table of contents for a component in the body of
a document
[x] tocentry - A component title in a table of contents
[x] tocfront - An entry in a table of contents for a front matter component
[x] toclevel1 - A top-level entry within a table of contents entry for a
chapter-like component
[x] toclevel2 - A second-level entry within a table of contents entry for a
chapter-like component
[x] toclevel3 - A third-level entry within a table of contents entry for a
chapter-like component
[x] toclevel4 - A fourth-level entry within a table of contents entry for a
chapter-like component
[x] toclevel5 - A fifth-level entry within a table of contents entry for a
chapter-like component
[x] tocpart - An entry in a table of contents for a part of a book
[ ] token - A unit of information
[x] tr - A row in an HTML table
[ ] trademark - A trademark
[x] type - The classification of a value
[x] ulink - A link that addresses its target by means of a URL
(Uniform Resource Locator)
[x] uri - A Uniform Resource Identifier
[x] userinput - Data entered by the user
[x] varargs - An empty element in a function synopsis indicating a variable
number of arguments
[x] variablelist - A list in which each entry is composed of a set of one or
more terms and an associated description
[x] varlistentry - A wrapper for a set of terms and the associated description
in a variable list
[x] varname - The name of a variable
[ ] videodata - Pointer to external video data
[ ] videoobject - A wrapper for video data and its associated meta-information
[ ] void - An empty element in a function synopsis indicating that the
function in question takes no arguments
[ ] volumenum - The volume number of a document in a set (as of books in a set
or articles in a journal)
[x] warning - An admonition set off from the text
[x] wordasword - A word meant specifically as a word and not representing
anything else
[x] xref - A cross reference to another part of the document
[ ] year - The year of publication of a document
[x] ?asciidoc-br? - line break from asciidoc docbook output
-}
type DB m = StateT DBState m
data DBState = DBState{ dbSectionLevel :: Int
, dbQuoteType :: QuoteType
, dbMeta :: Meta
, dbBook :: Bool
, dbFigureTitle :: Inlines
, dbContent :: [Content]
} deriving Show
instance Default DBState where
def = DBState{ dbSectionLevel = 0
, dbQuoteType = DoubleQuote
, dbMeta = mempty
, dbBook = False
, dbFigureTitle = mempty
, dbContent = [] }
readDocBook :: PandocMonad m => ReaderOptions -> Text -> m Pandoc
readDocBook _ inp = do
let tree = normalizeTree . parseXML . handleInstructions
$ T.unpack $ crFilter inp
(bs, st') <- flip runStateT (def{ dbContent = tree }) $ mapM parseBlock tree
return $ Pandoc (dbMeta st') (toList . mconcat $ bs)
-- We treat <?asciidoc-br?> specially (issue #1236), converting it
-- to <br/>, since xml-light doesn't parse the instruction correctly.
-- Other xml instructions are simply removed from the input stream.
handleInstructions :: String -> String
handleInstructions ('<':'?':'a':'s':'c':'i':'i':'d':'o':'c':'-':'b':'r':'?':'>':xs) = '<':'b':'r':'/':'>': handleInstructions xs
handleInstructions xs = case break (=='<') xs of
(ys, []) -> ys
([], '<':zs) -> '<' : handleInstructions zs
(ys, zs) -> ys ++ handleInstructions zs
getFigure :: PandocMonad m => Element -> DB m Blocks
getFigure e = do
tit <- case filterChild (named "title") e of
Just t -> getInlines t
Nothing -> return mempty
modify $ \st -> st{ dbFigureTitle = tit }
res <- getBlocks e
modify $ \st -> st{ dbFigureTitle = mempty }
return res
-- normalize input, consolidating adjacent Text and CRef elements
normalizeTree :: [Content] -> [Content]
normalizeTree = everywhere (mkT go)
where go :: [Content] -> [Content]
go (Text (CData CDataRaw _ _):xs) = xs
go (Text (CData CDataText s1 z):Text (CData CDataText s2 _):xs) =
Text (CData CDataText (s1 ++ s2) z):xs
go (Text (CData CDataText s1 z):CRef r:xs) =
Text (CData CDataText (s1 ++ convertEntity r) z):xs
go (CRef r:Text (CData CDataText s1 z):xs) =
Text (CData CDataText (convertEntity r ++ s1) z):xs
go (CRef r1:CRef r2:xs) =
Text (CData CDataText (convertEntity r1 ++ convertEntity r2) Nothing):xs
go xs = xs
convertEntity :: String -> String
convertEntity e = Data.Maybe.fromMaybe (map toUpper e) (lookupEntity e)
-- convenience function to get an attribute value, defaulting to ""
attrValue :: String -> Element -> String
attrValue attr elt =
fromMaybe "" (lookupAttrBy (\x -> qName x == attr) (elAttribs elt))
-- convenience function
named :: String -> Element -> Bool
named s e = qName (elName e) == s
--
addMetadataFromElement :: PandocMonad m => Element -> DB m Blocks
addMetadataFromElement e = do
case filterChild (named "title") e of
Nothing -> return ()
Just z -> do
getInlines z >>= addMeta "title"
addMetaField "subtitle" z
case filterChild (named "authorgroup") e of
Nothing -> return ()
Just z -> addMetaField "author" z
addMetaField "subtitle" e
addMetaField "author" e
addMetaField "date" e
addMetaField "release" e
return mempty
where addMetaField fieldname elt =
case filterChildren (named fieldname) elt of
[] -> return ()
[z] -> getInlines z >>= addMeta fieldname
zs -> mapM getInlines zs >>= addMeta fieldname
addMeta :: PandocMonad m => ToMetaValue a => String -> a -> DB m ()
addMeta field val = modify (setMeta field val)
instance HasMeta DBState where
setMeta field v s = s {dbMeta = setMeta field v (dbMeta s)}
deleteMeta field s = s {dbMeta = deleteMeta field (dbMeta s)}
isBlockElement :: Content -> Bool
isBlockElement (Elem e) = qName (elName e) `elem` blocktags
where blocktags = ["toc","index","para","formalpara","simpara",
"ackno","epigraph","blockquote","bibliography","bibliodiv",
"biblioentry","glossee","glosseealso","glossary",
"glossdiv","glosslist","chapter","appendix","preface",
"bridgehead","sect1","sect2","sect3","sect4","sect5","section",
"refsect1","refsect2","refsect3","refsection",
"important","caution","note","tip","warning","qandadiv",
"question","answer","abstract","itemizedlist","orderedlist",
"variablelist","article","book","table","informaltable",
"informalexample", "linegroup",
"screen","programlisting","example","calloutlist"]
isBlockElement _ = False
-- Trim leading and trailing newline characters
trimNl :: String -> String
trimNl = reverse . go . reverse . go
where go ('\n':xs) = xs
go xs = xs
-- meld text into beginning of first paragraph of Blocks.
-- assumes Blocks start with a Para; if not, does nothing.
addToStart :: Inlines -> Blocks -> Blocks
addToStart toadd bs =
case toList bs of
(Para xs : rest) -> para (toadd <> fromList xs) <> fromList rest
_ -> bs
-- function that is used by both mediaobject (in parseBlock)
-- and inlinemediaobject (in parseInline)
-- A DocBook mediaobject is a wrapper around a set of alternative presentations
getMediaobject :: PandocMonad m => Element -> DB m Inlines
getMediaobject e = do
(imageUrl, attr) <-
case filterChild (named "imageobject") e of
Nothing -> return (mempty, nullAttr)
Just z -> case filterChild (named "imagedata") z of
Nothing -> return (mempty, nullAttr)
Just i -> let atVal a = attrValue a i
w = case atVal "width" of
"" -> []
d -> [("width", d)]
h = case atVal "depth" of
"" -> []
d -> [("height", d)]
atr = (atVal "id", words $ atVal "role", w ++ h)
in return (atVal "fileref", atr)
let getCaption el = case filterChild (\x -> named "caption" x
|| named "textobject" x
|| named "alt" x) el of
Nothing -> return mempty
Just z -> mconcat <$>
mapM parseInline (elContent z)
figTitle <- gets dbFigureTitle
let (caption, title) = if isNull figTitle
then (getCaption e, "")
else (return figTitle, "fig:")
fmap (imageWith attr imageUrl title) caption
getBlocks :: PandocMonad m => Element -> DB m Blocks
getBlocks e = mconcat <$>
mapM parseBlock (elContent e)
parseBlock :: PandocMonad m => Content -> DB m Blocks
parseBlock (Text (CData CDataRaw _ _)) = return mempty -- DOCTYPE
parseBlock (Text (CData _ s _)) = if all isSpace s
then return mempty
else return $ plain $ trimInlines $ text s
parseBlock (CRef x) = return $ plain $ str $ map toUpper x
parseBlock (Elem e) =
case qName (elName e) of
"remark"-> return mempty
"toc" -> return mempty -- skip TOC, since in pandoc it's autogenerated
"index" -> return mempty -- skip index, since page numbers meaningless
"para" -> parseMixed para (elContent e)
"formalpara" -> do
tit <- case filterChild (named "title") e of
Just t -> (para . strong . (<> str ".")) <$>
getInlines t
Nothing -> return mempty
(tit <>) <$> parseMixed para (elContent e)
"simpara" -> parseMixed para (elContent e)
"ackno" -> parseMixed para (elContent e)
"epigraph" -> parseBlockquote
"blockquote" -> parseBlockquote
"attribution" -> return mempty
"titleabbrev" -> return mempty
"authorinitials" -> return mempty
"bibliography" -> sect 0
"bibliodiv" -> sect 1
"biblioentry" -> parseMixed para (elContent e)
"bibliomixed" -> parseMixed para (elContent e)
"equation" -> para <$> equation e displayMath
"informalequation" -> para <$> equation e displayMath
"glosssee" -> para . (\ils -> text "See " <> ils <> str ".")
<$> getInlines e
"glossseealso" -> para . (\ils -> text "See also " <> ils <> str ".")
<$> getInlines e
"glossary" -> sect 0
"glossdiv" -> definitionList <$>
mapM parseGlossEntry (filterChildren (named "glossentry") e)
"glosslist" -> definitionList <$>
mapM parseGlossEntry (filterChildren (named "glossentry") e)
- "chapter" -> sect 0
+ "chapter" -> getBlocks e
"appendix" -> sect 0
"preface" -> sect 0
"bridgehead" -> para . strong <$> getInlines e
"sect1" -> sect 1
"sect2" -> sect 2
"sect3" -> sect 3
"sect4" -> sect 4
"sect5" -> sect 5
"section" -> gets dbSectionLevel >>= sect . (+1)
"refsect1" -> sect 1
"refsect2" -> sect 2
"refsect3" -> sect 3
"refsection" -> gets dbSectionLevel >>= sect . (+1)
"important" -> divWith ("", ["important"], []) <$>
getBlocks e
"caution" -> blockQuote . (para (strong $ str "Caution") <>)
<$> getBlocks e
"note" -> divWith ("", ["note"], []) <$>
getBlocks e
"tip" -> blockQuote . (para (strong $ str "Tip") <>)
<$> getBlocks e
"warning" -> divWith ("", ["warning"], []) <$>
getBlocks e
"area" -> return mempty
"areaset" -> return mempty
"areaspec" -> return mempty
"qandadiv" -> gets dbSectionLevel >>= sect . (+1)
"question" -> addToStart (strong (str "Q:") <> str " ") <$> getBlocks e
"answer" -> addToStart (strong (str "A:") <> str " ") <$> getBlocks e
"abstract" -> blockQuote <$> getBlocks e
"calloutlist" -> bulletList <$> callouts
"itemizedlist" -> bulletList <$> listitems
"orderedlist" -> do
let listStyle = case attrValue "numeration" e of
"arabic" -> Decimal
"loweralpha" -> LowerAlpha
"upperalpha" -> UpperAlpha
"lowerroman" -> LowerRoman
"upperroman" -> UpperRoman
_ -> Decimal
let start = fromMaybe 1 $
(attrValue "override" <$> filterElement (named "listitem") e)
>>= safeRead
orderedListWith (start,listStyle,DefaultDelim)
<$> listitems
"variablelist" -> definitionList <$> deflistitems
"figure" -> getFigure e
"mediaobject" -> para <$> getMediaobject e
"caption" -> return mempty
"info" -> addMetadataFromElement e
"articleinfo" -> addMetadataFromElement e
"sectioninfo" -> return mempty -- keywords & other metadata
"refsectioninfo" -> return mempty -- keywords & other metadata
"refsect1info" -> return mempty -- keywords & other metadata
"refsect2info" -> return mempty -- keywords & other metadata
"refsect3info" -> return mempty -- keywords & other metadata
"sect1info" -> return mempty -- keywords & other metadata
"sect2info" -> return mempty -- keywords & other metadata
"sect3info" -> return mempty -- keywords & other metadata
"sect4info" -> return mempty -- keywords & other metadata
"sect5info" -> return mempty -- keywords & other metadata
"chapterinfo" -> return mempty -- keywords & other metadata
"glossaryinfo" -> return mempty -- keywords & other metadata
"appendixinfo" -> return mempty -- keywords & other metadata
"bookinfo" -> addMetadataFromElement e
"article" -> modify (\st -> st{ dbBook = False }) >>
addMetadataFromElement e >> getBlocks e
"book" -> modify (\st -> st{ dbBook = True }) >>
addMetadataFromElement e >> getBlocks e
"table" -> parseTable
"informaltable" -> parseTable
"informalexample" -> divWith ("", ["informalexample"], []) <$>
getBlocks e
"linegroup" -> lineBlock <$> lineItems
"literallayout" -> codeBlockWithLang
"screen" -> codeBlockWithLang
"programlisting" -> codeBlockWithLang
"synopsis" -> synopsis
"?xml" -> return mempty
"title" -> return mempty -- handled in parent element
"subtitle" -> return mempty -- handled in parent element
_ -> getBlocks e
where parseMixed container conts = do
let (ils,rest) = break isBlockElement conts
ils' <- (trimInlines . mconcat) <$> mapM parseInline ils
let p = if ils' == mempty then mempty else container ils'
case rest of
[] -> return p
(r:rs) -> do
b <- parseBlock r
x <- parseMixed container rs
return $ p <> b <> x
codeBlockWithLang = do
let classes' = case attrValue "language" e of
"" -> []
x -> [x]
return $ codeBlockWith (attrValue "id" e, classes', [])
$ trimNl $ strContentRecursive e
synopsis = do
return $ codeBlockWith (attrValue "id" e, ["synopsis"], [])
$ trimNl $ strContentRecursive e
parseBlockquote = do
attrib <- case filterChild (named "attribution") e of
Nothing -> return mempty
Just z -> (para . (str "— " <>) . mconcat)
<$>
mapM parseInline (elContent z)
contents <- getBlocks e
return $ blockQuote (contents <> attrib)
listitems = mapM getBlocks $ filterChildren (named "listitem") e
callouts = mapM getBlocks $ filterChildren (named "callout") e
deflistitems = mapM parseVarListEntry $ filterChildren
(named "varlistentry") e
parseVarListEntry e' = do
let terms = filterChildren (named "term") e'
let items = filterChildren (named "listitem") e'
terms' <- mapM getInlines terms
items' <- mapM getBlocks items
return (mconcat $ intersperse (str "; ") terms', items')
parseGlossEntry e' = do
let terms = filterChildren (named "glossterm") e'
let items = filterChildren (named "glossdef") e'
terms' <- mapM getInlines terms
items' <- mapM getBlocks items
return (mconcat $ intersperse (str "; ") terms', items')
parseTable = do
let isCaption x = named "title" x || named "caption" x
caption <- case filterChild isCaption e of
Just t -> getInlines t
Nothing -> return mempty
let e' = fromMaybe e $ filterChild (named "tgroup") e
let isColspec x = named "colspec" x || named "col" x
let colspecs = case filterChild (named "colgroup") e' of
Just c -> filterChildren isColspec c
_ -> filterChildren isColspec e'
let isRow x = named "row" x || named "tr" x
headrows <- case filterChild (named "thead") e' of
Just h -> case filterChild isRow h of
Just x -> parseRow x
Nothing -> return []
Nothing -> return []
bodyrows <- case filterChild (named "tbody") e' of
Just b -> mapM parseRow
$ filterChildren isRow b
Nothing -> mapM parseRow
$ filterChildren isRow e'
let toAlignment c = case findAttr (unqual "align") c of
Just "left" -> AlignLeft
Just "right" -> AlignRight
Just "center" -> AlignCenter
_ -> AlignDefault
let toWidth c = case findAttr (unqual "colwidth") c of
Just w -> fromMaybe 0
$ safeRead $ '0': filter (\x ->
(x >= '0' && x <= '9')
|| x == '.') w
Nothing -> 0 :: Double
let numrows = case bodyrows of
[] -> 0
xs -> maximum $ map length xs
let aligns = case colspecs of
[] -> replicate numrows AlignDefault
cs -> map toAlignment cs
let widths = case colspecs of
[] -> replicate numrows 0
cs -> let ws = map toWidth cs
tot = sum ws
in if all (> 0) ws
then map (/ tot) ws
else replicate numrows 0
let headrows' = if null headrows
then replicate numrows mempty
else headrows
return $ table caption (zip aligns widths)
headrows' bodyrows
isEntry x = named "entry" x || named "td" x || named "th" x
parseRow = mapM (parseMixed plain . elContent) . filterChildren isEntry
sect n = do isbook <- gets dbBook
let n' = if isbook || n == 0 then n + 1 else n
headerText <- case filterChild (named "title") e `mplus`
(filterChild (named "info") e >>=
filterChild (named "title")) of
Just t -> getInlines t
Nothing -> return mempty
modify $ \st -> st{ dbSectionLevel = n }
b <- getBlocks e
let ident = attrValue "id" e
modify $ \st -> st{ dbSectionLevel = n - 1 }
return $ headerWith (ident,[],[]) n' headerText <> b
lineItems = mapM getInlines $ filterChildren (named "line") e
getInlines :: PandocMonad m => Element -> DB m Inlines
getInlines e' = (trimInlines . mconcat) <$>
mapM parseInline (elContent e')
strContentRecursive :: Element -> String
strContentRecursive = strContent .
(\e' -> e'{ elContent = map elementToStr $ elContent e' })
elementToStr :: Content -> Content
elementToStr (Elem e') = Text $ CData CDataText (strContentRecursive e') Nothing
elementToStr x = x
parseInline :: PandocMonad m => Content -> DB m Inlines
parseInline (Text (CData _ s _)) = return $ text s
parseInline (CRef ref) =
return $ maybe (text $ map toUpper ref) text $ lookupEntity ref
parseInline (Elem e) =
case qName (elName e) of
"equation" -> equation e displayMath
"informalequation" -> equation e displayMath
"inlineequation" -> equation e math
"subscript" -> subscript <$> innerInlines
"superscript" -> superscript <$> innerInlines
"inlinemediaobject" -> getMediaobject e
"quote" -> do
qt <- gets dbQuoteType
let qt' = if qt == SingleQuote then DoubleQuote else SingleQuote
modify $ \st -> st{ dbQuoteType = qt' }
contents <- innerInlines
modify $ \st -> st{ dbQuoteType = qt }
return $ if qt == SingleQuote
then singleQuoted contents
else doubleQuoted contents
"simplelist" -> simpleList
"segmentedlist" -> segmentedList
"classname" -> codeWithLang
"code" -> codeWithLang
"filename" -> codeWithLang
"literal" -> codeWithLang
"computeroutput" -> codeWithLang
"prompt" -> codeWithLang
"parameter" -> codeWithLang
"option" -> codeWithLang
"optional" -> do x <- getInlines e
return $ str "[" <> x <> str "]"
"markup" -> codeWithLang
"wordasword" -> emph <$> innerInlines
"command" -> codeWithLang
"varname" -> codeWithLang
"function" -> codeWithLang
"type" -> codeWithLang
"symbol" -> codeWithLang
"constant" -> codeWithLang
"userinput" -> codeWithLang
"varargs" -> return $ code "(...)"
"keycap" -> return (str $ strContent e)
"keycombo" -> keycombo <$>
mapM parseInline (elContent e)
"menuchoice" -> menuchoice <$>
mapM parseInline (
filter isGuiMenu $ elContent e)
"xref" -> do
content <- dbContent <$> get
let linkend = attrValue "linkend" e
let title = case attrValue "endterm" e of
"" -> maybe "???" xrefTitleByElem
(findElementById linkend content)
endterm -> maybe "???" strContent
(findElementById endterm content)
return $ link ('#' : linkend) "" (text title)
"email" -> return $ link ("mailto:" ++ strContent e) ""
$ str $ strContent e
"uri" -> return $ link (strContent e) "" $ str $ strContent e
"ulink" -> link (attrValue "url" e) "" <$> innerInlines
"link" -> do
ils <- innerInlines
let href = case findAttr (QName "href" (Just "http://www.w3.org/1999/xlink") Nothing) e of
Just h -> h
_ -> '#' : attrValue "linkend" e
let ils' = if ils == mempty then str href else ils
let attr = (attrValue "id" e, words $ attrValue "role" e, [])
return $ linkWith attr href "" ils'
"foreignphrase" -> emph <$> innerInlines
+ "phrase" -> case attrValue "revisionflag" e of
+ "added" -> innerInlines
+ "changed" -> innerInlines
+ "deleted" -> return mempty
+ "off" -> return mempty
+ _ -> innerInlines
"emphasis" -> case attrValue "role" e of
"bold" -> strong <$> innerInlines
"strong" -> strong <$> innerInlines
"strikethrough" -> strikeout <$> innerInlines
_ -> emph <$> innerInlines
"footnote" -> (note . mconcat) <$>
mapM parseBlock (elContent e)
"title" -> return mempty
"affiliation" -> return mempty
-- Note: this isn't a real docbook tag; it's what we convert
-- <?asciidor-br?> to in handleInstructions, above. A kludge to
-- work around xml-light's inability to parse an instruction.
"br" -> return linebreak
_ -> innerInlines
where innerInlines = (trimInlines . mconcat) <$>
mapM parseInline (elContent e)
codeWithLang = do
let classes' = case attrValue "language" e of
"" -> []
l -> [l]
return $ codeWith (attrValue "id" e,classes',[]) $ strContentRecursive e
simpleList = (mconcat . intersperse (str "," <> space)) <$> mapM getInlines
(filterChildren (named "member") e)
segmentedList = do
tit <- maybe (return mempty) getInlines $ filterChild (named "title") e
segtits <- mapM getInlines $ filterChildren (named "segtitle") e
segitems <- mapM (mapM getInlines . filterChildren (named "seg"))
$ filterChildren (named "seglistitem") e
let toSeg = mconcat . zipWith (\x y -> strong (x <> str ":") <> space <>
y <> linebreak) segtits
let segs = mconcat $ map toSeg segitems
let tit' = if tit == mempty
then mempty
else strong tit <> linebreak
return $ linebreak <> tit' <> segs
keycombo = spanWith ("",["keycombo"],[]) .
mconcat . intersperse (str "+")
menuchoice = spanWith ("",["menuchoice"],[]) .
mconcat . intersperse (text " > ")
isGuiMenu (Elem x) = named "guimenu" x || named "guisubmenu" x ||
named "guimenuitem" x
isGuiMenu _ = False
findElementById idString content
= asum [filterElement (\x -> attrValue "id" x == idString) el | Elem el <- content]
-- Use the 'xreflabel' attribute for getting the title of a xref link;
-- if there's no such attribute, employ some heuristics based on what
-- docbook-xsl does.
xrefTitleByElem el
| not (null xrefLabel) = xrefLabel
| otherwise = case qName (elName el) of
"chapter" -> descendantContent "title" el
"section" -> descendantContent "title" el
"sect1" -> descendantContent "title" el
"sect2" -> descendantContent "title" el
"sect3" -> descendantContent "title" el
"sect4" -> descendantContent "title" el
"sect5" -> descendantContent "title" el
"cmdsynopsis" -> descendantContent "command" el
"funcsynopsis" -> descendantContent "function" el
_ -> qName (elName el) ++ "_title"
where
xrefLabel = attrValue "xreflabel" el
descendantContent name = maybe "???" strContent
. filterElementName (\n -> qName n == name)
-- | Extract a math equation from an element
--
-- asciidoc can generate Latex math in CDATA sections.
--
-- Note that if some MathML can't be parsed it is silently ignored!
equation
:: Monad m
=> Element
-- ^ The element from which to extract a mathematical equation
-> (String -> Inlines)
-- ^ A constructor for some Inlines, taking the TeX code as input
-> m Inlines
equation e constructor =
return $ mconcat $ map constructor $ mathMLEquations ++ latexEquations
where
mathMLEquations :: [String]
mathMLEquations = map writeTeX $ rights $ readMath
(\x -> qName (elName x) == "math" && qPrefix (elName x) == Just "mml")
(readMathML . showElement)
latexEquations :: [String]
latexEquations = readMath (\x -> qName (elName x) == "mathphrase")
(concat . fmap showVerbatimCData . elContent)
readMath :: (Element -> Bool) -> (Element -> b) -> [b]
readMath childPredicate fromElement =
( map (fromElement . everywhere (mkT removePrefix))
$ filterChildren childPredicate e
)
-- | Get the actual text stored in a verbatim CData block. 'showContent'
-- returns the text still surrounded by the [[CDATA]] tags.
--
-- Returns 'showContent' if this is not a verbatim CData
showVerbatimCData :: Content -> String
showVerbatimCData (Text (CData CDataVerbatim d _)) = d
showVerbatimCData c = showContent c
-- | Set the prefix of a name to 'Nothing'
removePrefix :: QName -> QName
removePrefix elname = elname { qPrefix = Nothing }
diff --git a/documentation-tools/doc-converter/doctl b/documentation-tools/doc-converter/doctl
new file mode 100755
index 0000000..1de5c7d
--- /dev/null
+++ b/documentation-tools/doc-converter/doctl
@@ -0,0 +1,61 @@
+#!/bin/bash
+PANDOC=/opt/pandoc/dist-newstyle/build/x86_64-linux/ghc-8.6.4/pandoc-2.7.1/x/pandoc/build/pandoc/pandoc
+REMOTE='xreate@xreate.bigserver'
+DOC_CONTENT=(
+ 'documentation/Transcend/transcend.xml'
+ 'documentation/Transcend/ast-api.xml'
+ 'documentation/Transcend/latetranscend.xml'
+ 'documentation/Transcend/modules-api.xml'
+ 'documentation/Transcend/latex-api.xml'
+ 'documentation/Concepts/interpretation.xml'
+ 'documentation/Concepts/containers.xml'
+ 'documentation/Concepts/polymorphism.xml'
+ 'documentation/Concepts/context.xml'
+ 'documentation/Syntax/syntax.xml'
+ 'documentation/Syntax/modules.xml'
+ 'documentation/virtualization.xml'
+ 'documentation/exploitation.xml'
+ 'documentation/communication.xml'
+ 'documentation/index.xml'
+)
+PWD=`pwd`
+Filename=`realpath $0`
+
+upload () {
+ convert_all /tmp/docs2
+ rsync -e 'ssh -p24' -rtvz $Filename $REMOTE:/opt/doctl
+ rsync -e 'ssh -p24' -rtvz /tmp/docs2/ $REMOTE:/opt/documentation/
+ rsync -e 'ssh -p24' -rtvz $PWD/documentation/manual.json $REMOTE:/opt/documentation/
+}
+
+convert (){
+ SOURCE_FILE=$1
+ DEST_FOLDER=$2
+ Name=$(basename $SOURCE_FILE)
+ sed -e '/<?xxe-revisions/, /?>/ d' -e 's/<?xxe[^?]*?>//g' $SOURCE_FILE | \
+ $PANDOC \
+ -f docbook \
+ -t $PWD/documentation-tools/doc-converter/remarkup.lua \
+ -o $DEST_FOLDER/$Name.remarkup
+}
+
+convert_all (){
+ DEST_FOLDER=$1
+ mkdir -p $DEST_FOLDER
+ for Chapter in ${DOC_CONTENT[@]}; do
+ convert $PWD/$Chapter $DEST_FOLDER
+ done
+}
+
+case $1 in
+ convert)
+ convert $2 $3
+ ;;
+ convert-all)
+ convert_all $2
+ ;;
+ upload)
+ upload $2
+ ;;
+ *) echo "usage: $0 convert <SOURCE-FILE> <DEST-FOLDER> | convert-all <DEST-FOLDER> | upload";;
+esac
diff --git a/documentation/index.xml b/documentation/index.xml
index f31c7d6..d359a74 100644
--- a/documentation/index.xml
+++ b/documentation/index.xml
@@ -1,318 +1,356 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.1" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xila="http://www.w3.org/2001/XInclude/local-attributes"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:trans="http://docbook.org/ns/transclusion"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:db="http://docbook.org/ns/docbook">
<?xxe-sn 2b06cb2u4g0 1?>
<title><?xxe-sn 2b06cb2u4g0 2?>Xreate Manual</title>
<para><?xxe-sn 2b06cb2u4g0 6?>Xreate is an open source general purpose high
level programming language designed to write efficient and safe computer
programs.</para>
- <para><?xxe-sn 2b06cb2u4g0 8?>Here "high level" has very specific meaning as
- an ability to easily write, read, as well as adapt software to a constantly
- changing environment or business goals. In this respect, any software
- product can be evaluated on the basis of the three dimensions: efficiency,
- safety and adaptability. Unfortunately, those properties are proved to be
- largely contradictory for it is manageable to write either efficient(still
- unsafe) or safe(and impractical) code, but not both. Thus, the ultimate goal
- of the language is to allow developers to produce code with all these
- properties at the same time. Xreate's design principles allow to adopt any
- programming technique as long as it does not improve one dimension at the
- expense of another.</para>
-
- <para><?xxe-sn 2b06cb2u4g0 7?>To achieve aforementioned design goals Xreate
- has tree distinctive layers:</para>
+ <para><?xxe-sn 2b06cb2u4g0 8?>Here "high level" has very specific meaning,
+ implying an ability to easily write, read, as well as adapt software to a
+ constantly changing environment or business goals. In this respect, any
+ software product can be evaluated on the basis of the three dimensions:
+ efficiency, safety, and adaptability. Unfortunately, those properties are
+ proved to be largely contradictory, for it is manageable to write either
+ efficient (yet unsafe) or safe (yet impractical) code, but not both. Thus,
+ the ultimate goal of the language is to allow developers to produce code
+ that would have all these properties at the same time. Xreate's design
+ principles allow to adopt any programming technique as long as it does not
+ improve one dimension at the expense of another.</para>
+
+ <para><?xxe-sn 2b06cb2u4g0 7?>To achieve the aforementioned design goals,
+ Xreate employs three distinctive layers:</para>
<itemizedlist>
<?xxe-sn 2b06cb2u4g0 e?>
<listitem>
<?xxe-sn 2b06cb2u4g0 f?>
<para><?xxe-sn 2b06cb2u4g0 g?><link xlink:href="/w/syntax"><?xxe-sn 2b06cb2u4g0 o?>Brute</link>.
- Lowest layer is called <emphasis><?xxe-sn 2b06cb2u4g0 p?>Brute</emphasis>—
- this is code that is indented to be actually compiled. Code on this
- level implements actual software functionality. It resembles the usual
- imperative languages' apparatus and consists of executable instructions
- such as arithmetic, branching, input/output, etc.</para>
+ The lowest layer is called <emphasis><?xxe-sn 2b06cb2u4g0 p?>Brute
+ </emphasis>— this is code that is intended to be actually compiled. Code
+ on this level implements actual software functionality. It resembles the
+ usual imperative languages' apparatus and consists of executable
+ instructions such as arithmetic, branching, input/output, etc.</para>
</listitem>
<listitem>
<?xxe-sn 2b06cb2u4g0 i?>
<para><?xxe-sn 2b06cb2u4g0 j?><link xlink:href="/w/transcend"><?xxe-sn 2b06cb2u4g0 q?>Transcend</link>.
- Brute level alone is not enough to constitute full fledged language
- since a code requires various non executable metadata to express
+ Brute level alone is not enough to constitute a full-fledged language
+ since code requires various non-executable metadata to express
developer's intents, check correctness, validity and perform other types
of analyses. In Xreate everything of this sort belongs to a layer called
- <emphasis><?xxe-sn 2b06cb2u4g0 s?>Transcend</emphasis>. Transcend
- features declarative nature that is appropriate to do management kind of
- work — it analyzes, oversees and controls brute by guiding compilation
- process. Everything that is on this level — logic or transcend facts and
- rules are gathered and sent to an external logic solver to make
- solutions that are brought back in order to guide compilation.</para>
+ <emphasis><?xxe-sn 2b06cb2u4g0 s?>Transcend</emphasis>. Transcend due to
+ its declarative nature is appropriate to do management-type work — it
+ analyzes, oversees and controls brute by guiding compilation process.
+ Everything on this level — logic or transcend facts and rules — is
+ gathered and sent to an external logic solver to make solutions that are
+ brought back in order to guide compilation.</para>
</listitem>
<listitem>
<?xxe-sn 2b06cb2u4g0 l?>
<para><?xxe-sn 2b06cb2u4g0 m?><link
xlink:href="/w/concepts/interpretation/"><?xxe-sn 2b06cb2u4g0 r?>Interpretation</link>.
- And there is also <emphasis><?xxe-sn 2b06cb2u4g0 t?>Interpretation</emphasis>
- — intermediate level resembling features of dynamically typed languages
- that is used as a contact point and interpreter between brute and
- transcend and their low level and high level constructs and structures
- respectively.</para>
+ There is also <emphasis><?xxe-sn 2b06cb2u4g0 t?>Interpretation</emphasis>
+ — the intermediate level resembling dynamically typed languages that is
+ used as a contact point and interpreter between brute and transcend and
+ their respective low level and high level constructs and
+ structures.</para>
</listitem>
</itemizedlist>
- <para><?xxe-sn 2b06cb2u4g0 u?>On a syntactic level Xreate is procedural
+ <para><?xxe-sn 2b06cb2u4g0 u?>On a syntactic level, Xreate is a procedural
language with extensive use of <emphasis><?xxe-sn 2b06cb2u4g0 v?><link
xlink:href="/w/transcend"><?xxe-sn 2b06cb2u4g0 w?>annotations</link></emphasis>
- — arbitrary unconstrained metadata that software developer can attach to a
+ — arbitrary unconstrained metadata that software developer can attach to
different language constructs, variables and code blocks. Annotations are
- completely invisible for the compiler proper and used by transcend rather as
- suggestions conveying additional information.</para>
+ completely invisible for the compiler proper and used by transcend more as a
+ suggestion conveying additional information.</para>
+
+ <remark><?xxe-sn 2ccp2iy80zj 1td6aqezxvj7l?>"a different language
+ constructs": если подразумевается "конструкции разных языков", тогда лучше
+ "different languages' constructs". Если конструкции языка, в целом, то тогда
+ артикль a не нужен</remark>
<para xlink:href="w/virtualization/"><?xxe-sn 2b3f3osfk74 g?>Most severe and
hard to resolve problems in software development stem from interaction of
- different components on a different levels. Each individual component often
- is thoroughly tested and works reliably. But combining them with complex
- interaction and extensive IO to build end-user software usually leads to a
- range of runtime errors, security vulnerabilities and performance
- degradation. Thus key emphasis of Xreate is on domain specific component
- level improvements and joint use of external resources. This aspect is
- covered in <link xlink:href="/w/exploitation/"><?xxe-sn 2b3f3osfk74 h?>exploitation</link>
+ different components on different levels. Each individual component often is
+ thoroughly tested and works reliably. But combining them when building
+ end-user software for which purpose complex interaction and extensive IO is
+ enabled usually leads to a range of runtime errors, security vulnerabilities
+ and performance degradation.</para>
+
+ <para xlink:href="w/virtualization/"><?xxe-sn 2cdtco54w00 2?>Thus Xreate
+ places key emphasis on domain-specific component level improvements and
+ joint use of external resources. This aspect is covered in <link
+ xlink:href="/w/exploitation/"><?xxe-sn 2b3f3osfk74 h?>exploitation</link>
and <link xlink:href="/w/concepts/containers/"><?xxe-sn 2b3f3osfk74 i?>containers</link>
- chapters. Unlike academic languages, Xreate targets safe and reliable usage
- of effectful computations, such as IO, covered in <link
- xlink:href="/w/virtualization"><?xxe-sn 2b3f3osfk74 j?>virtualization</link>,
- <link xlink:href="/w/exploitation/"><?xxe-sn 2b3f3osfk74 k?>exploitation</link>
- chapters and mutable structures covered in <link
+ chapters.</para>
+
+ <para xlink:href="w/virtualization/"><?xxe-sn 2cdtco54w00 3?>Unlike academic
+ languages, Xreate targets safe and reliable usage of effectful computations
+ such as IO covered in <link xlink:href="/w/virtualization"><?xxe-sn 2b3f3osfk74 j?>virtualization</link>
+ and <link xlink:href="/w/exploitation/"><?xxe-sn 2b3f3osfk74 k?>exploitation</link>
+ chapters, and mutable structures covered in <link
xlink:href="/w/communication/"><?xxe-sn 2b3f3osfk74 l?>communication</link>.</para>
<section>
<?xxe-sn 2b06cb2u4g0 3?>
<title><?xxe-sn 2b06cb2u4g0 4?>Basic Example</title>
<para><?xxe-sn 2b06cb2u4g0 5?>To demonstrate what Xreate is all about,
basic example is given below:</para>
<programlisting xml:id="Example_1"><?xxe-sn 2b06cb2u4g0 x?>name="tests/introduction.cpp: Introduction.Doc_Example_1", lines=15
guard:: iAmVeryFast
{
div = function(a:: float, b:: float):: float
{
a / b
}
}
guard:: iAmVerySafe
{
div = function(a:: float, b:: float):: float
{
if ( b == (0::float)):: float {0::float} else {a / b}
}
}
test = function:: float; entry; iAmVerySecure
{
div(10, 5)
}</programlisting>
<para><?xxe-sn 2b06cb2u4g0 y?>Here entry point of the program is a
- function <code><?xxe-sn 2b06cb2u4g0 z?>test</code> recognized so by the
+ function <code><?xxe-sn 2b06cb2u4g0 z?>test</code> recognized so by
compiler because of annotation <code><?xxe-sn 2b06cb2u4g0 10?>entry</code>
in its signature. There are also two functions <code><?xxe-sn 2b06cb2u4g0 11?>div</code>
called <emphasis><?xxe-sn 2b06cb2u4g0 12?>specializations</emphasis>. Each
- specialization has a guard that defines condition that has to be met in
+ specialization has a guard that defines a condition that has to be met in
order to invoke this particular specialization. In the example,
specializations of <code><?xxe-sn 2b06cb2u4g0 13?>div</code> have
<code><?xxe-sn 2b06cb2u4g0 14?>iAmVeryFast</code> and <code><?xxe-sn 2b06cb2u4g0 15?>iAmVerySafe</code>
- guards respectively. Let's say, developer provides two specializations
- where first is a very fast division implementation and second one is a
- very safe since it checks division by zero but at the same time is
- unbearably slow due to extra check instruction. This is a basis of <link
- xlink:href="/w/concepts/polymorphism/"><?xxe-sn 2b3f3osfk74 2?>polymorphism</link>
+ guards, respectively. Let's say that developer specifies two
+ specializations where the first one is a very fast division
+ implementation, while the second one is a very safe division
+ implementation since it checks division by zero, although it is
+ unacceptably slow due to an extra check instruction. This is a basis of
+ <link xlink:href="/w/concepts/polymorphism/"><?xxe-sn 2b3f3osfk74 2?>polymorphism</link>
— client's code <code><?xxe-sn 2b3f3osfk74 3?>test</code> is able to work
- with any specialization, and compiler should decide which one to invoke
- with the only hint it has — annotation <code><?xxe-sn 2b3f3osfk74 5?>iAmVerySecure</code>
+ with any specialization, and compiler must decide which one to invoke with
+ the only hint it has — annotation <code><?xxe-sn 2b3f3osfk74 5?>iAmVerySecure</code>
in the function <code><?xxe-sn 2b3f3osfk74 7?>test</code>'s
signature.</para>
+ <remark><?xxe-sn 2ccp2iy80zj 1td6aqezxvj7n?>"provides two specializations"
+ - возможно, лучший вариант "designates/assigns/allocates two
+ specializations". Или даже просто specifies/indicates. (PS заменил на
+ specifies)</remark>
+
+ <remark><?xxe-sn 2ccp2iy80zj 1td6aqezxvj7m?>"unbearably slow" - я бы
+ заменил на более нейтральное "too slow". Unbearable - это скорее об
+ ощущениях человека. Или, если под "unbearably" имеется в виду "недопустимо
+ медленный", тогда - unacceptably slow.</remark>
+
<note>
<?xxe-sn 2b3f3osfk74 n?>
- <para><?xxe-sn 2b3f3osfk74 o?>All annotations(except <code><?xxe-sn 2b3f3osfk74 m?>entry</code>)
+ <para><?xxe-sn 2b3f3osfk74 o?>All annotations (except <code><?xxe-sn 2b3f3osfk74 m?>entry</code>)
are custom defined by developer itself.</para>
</note>
<para><?xxe-sn 2b3f3osfk74 6?>This is when transcend comes into play. By
- adding transcend rule as shown below it is possible to associate
+ adding a transcend rule as shown below it is possible to associate
annotation <code><?xxe-sn 2b3f3osfk74 8?>iAmVerySecure</code> with
invocation of specialization guarded by <code><?xxe-sn 2b3f3osfk74 9?>iAmVerySafe:</code></para>
<programlisting xml:id="Transcend_Example_1"><?xxe-sn 2b3f3osfk74 a?>name="tests/introduction.cpp: Introduction.Doc_Example_1", lines=15
dfa_callguard(SiteInv, iAmVerySafe):-
dfa_callfn(SiteInv, div);
SiteInv = s(_, _, ScopeInv);
cfa_parent(ScopeInv, function(FnInv));
bind_func(FnInv, iAmVerySecure).</programlisting>
<para><?xxe-sn 2b3f3osfk74 b?>Transcend rules are written in ASP syntax —
common syntax to write logic programs. This particular rule reads that for
any function annotated with <code><?xxe-sn 2b3f3osfk74 c?>iAmVerySecure</code>,
certain specialization <code><?xxe-sn 2b3f3osfk74 d?>iAmVerySafe</code> is
chosen for <code><?xxe-sn 2b3f3osfk74 e?>div</code> invocation.</para>
<note>
<?xxe-sn 2b3f3osfk74 p?>
<para><?xxe-sn 2b3f3osfk74 q?>In this example an appropriate
- specialization is statically resolved, so other specialization isn't
+ specialization is statically resolved, so the other specialization isn't
even compiled.</para>
+
+ <remark><?xxe-sn 2ccp2iy80zj 1td6aqezxvj7o?>the, потому что их всего
+ две.</remark>
</note>
<para><?xxe-sn 2b3f3osfk74 f?>By providing custom rules it is possible to
- implement any polymorphism strategy, be it statically performed or
+ implement any polymorphism strategy, be it performed statically or
dynamically. The example demonstrates basic workflow: transcend gathers
- available information about a program, such as annotations and using
- custom rules makes decisions to guide compilation process particularly by
- selecting appropriate specializations as in this example.</para>
+ available information about a program such as annotations and using custom
+ rules makes a decision to guide compilation process, particularly by
+ selecting appropriate specializations as in the above example.</para>
</section>
<section>
<?xxe-sn 2ba2e84701s 1?>
<title><?xxe-sn 2ba2e84701s 2?>Build and Run on Linux</title>
- <para><?xxe-sn 2ba2e84701s 3?>Major dependencies: </para>
+ <para><?xxe-sn 2ba2e84701s 3?>Major dependencies:</para>
<itemizedlist>
<?xxe-sn 2ba2e84701s 4?>
<listitem>
<?xxe-sn 2ba2e84701s 5?>
<para><?xxe-sn 2ba2e84701s 6?>gcc 7</para>
</listitem>
<listitem>
<?xxe-sn 2ba2e84701s 7?>
<para><?xxe-sn 2ba2e84701s 8?>llvm 5, clang 5</para>
</listitem>
<listitem>
<?xxe-sn 2ba2e84701s 9?>
<para><?xxe-sn 2ba2e84701s a?>boost 1.66</para>
</listitem>
<listitem>
<?xxe-sn 2ba2e84701s b?>
<para><?xxe-sn 2ba2e84701s c?>coco</para>
</listitem>
<listitem>
<?xxe-sn 2ba2e84701s d?>
<para><?xxe-sn 2ba2e84701s e?>clingo</para>
</listitem>
</itemizedlist>
<para><?xxe-sn 2ba2e84701s f?>Building tested on <emphasis
- role="bold"><?xxe-sn 2ba2e84701s o?>OpenSuse Leap 15</emphasis>. Change
- commands accordingly if using another distribution. </para>
+ role="bold"><?xxe-sn 2ba2e84701s o?>OpenSuse Leap 15</emphasis>. Please
+ change commands accordingly if using other distributions.</para>
<para><?xxe-sn 2ba2e84701s p?>Pull sources directly from
repository:</para>
<literallayout><?xxe-sn 2ba2e84701s g?>git clone --recursive https://pgess@bitbucket.org/pgess/xreate.git</literallayout>
- <para><?xxe-sn 2ba2e84701s q?>Enter into source directory and run
- following script to prepare building environment. Script installs required
- system packages as well as Coco and Clingo from sources:</para>
+ <para><?xxe-sn 2ba2e84701s q?>Enter into the source directory and run the
+ following script to prepare building environment. Script will install the
+ required system packages as well as Coco and Clingo from sources:</para>
- <note>
- <?xxe-sn 2ba2e84701s 15?>
+ <remark><?xxe-sn 2ccp2iy80zj 1td6aqezxvj7p?>"Enter into source directory"
+ - тут перед directory явно нужен артикль. Гугл говорит, что определенный -
+ the</remark>
+
+ <important>
+ <?xxe-sn 2cdtco54w00 4?>
- <para><?xxe-sn 2ba2e84701s 16?>Carefully inspect scripts before
+ <para><?xxe-sn 2cdtco54w00 5?>Carefully inspect scripts before
run</para>
- </note>
+ </important>
<para><?xxe-sn 2ba2e84701s 13?>On <emphasis role="bold"><?xxe-sn 2ba2e84701s 14?>OpenSuse
Leap 15</emphasis>:</para>
<literallayout><?xxe-sn 2ba2e84701s t?>./installation/prepare-opensuse-leap15</literallayout>
<para><?xxe-sn 2ba2e84701s u?>That was one time operation to prepare
environment. After that enter into <code><?xxe-sn 2ba2e84701s v?>build</code>
directory and start actual tests building:</para>
+ <remark><?xxe-sn 2ccp2iy80zj 1td6aqezxvj7q?>"build directory": здесь ты
+ все-таки вначале указываешь имя объекта (build), и лишь потом родовое
+ название (directory)</remark>
+
<literallayout><?xxe-sn 2ba2e84701s w?>cd build
make</literallayout>
<para><?xxe-sn 2ba2e84701s x?>After successful build you can run xreate
tests:</para>
<literallayout><?xxe-sn 2ba2e84701s y?>cd ..
./build/tests/xreate-tests</literallayout>
<note>
<?xxe-sn 2ba2e84701s 1h?>
- <para><?xxe-sn 2ba2e84701s 1i?>Pay attention that working dir should be
- repository root</para>
+ <para><?xxe-sn 2ba2e84701s 1i?>Please pay attention that the working
+ directory should be the repository root</para>
</note>
- <para><?xxe-sn 2ba2e84701s 17?>For consequent rebuilds after updates. etc
+ <para><?xxe-sn 2ba2e84701s 17?>For consequent rebuilds after updates etc
invoke <code><?xxe-sn 2ba2e84701s 18?>cmake</code> as follows:</para>
<literallayout><?xxe-sn 2ba2e84701s 19?>#working dir build
cmake -DCMAKE_BUILD_TYPE=Debug \
-DBUILD_XREATE_TESTS=1 \
-DCOCO_EXECUTABLE=&lt;FILE&gt; \
-DCLINGO_PATH=&lt;DIR&gt; \
-DCOCO_FRAMES_PATH=../vendors/coco/generator/ \
-DCMAKE_CXX_COMPILER=g++ ../cpp
make</literallayout>
<para><?xxe-sn 2ba2e84701s 1j?>Cmake's selected parameters:</para>
<itemizedlist>
<?xxe-sn 2ba2e84701s 1a?>
<listitem>
<?xxe-sn 2ba2e84701s 1b?>
- <para><?xxe-sn 2ba2e84701s 1c?>BUILD_XREATE_TESTS determines whether
+ <para><?xxe-sn 2ba2e84701s 1c?>BUILD_XREATE_TESTS Determines whether
to build tests</para>
</listitem>
<listitem>
<?xxe-sn 2ba2e84701s 1d?>
- <para><?xxe-sn 2ba2e84701s 1e?>COCO_EXECUTABLE full filename of Coco
+ <para><?xxe-sn 2ba2e84701s 1e?>COCO_EXECUTABLE Full filename of Coco
executable</para>
</listitem>
<listitem>
<?xxe-sn 2ba2e84701s 1f?>
- <para><?xxe-sn 2ba2e84701s 1g?>CLINGO_PATH Directory of Clingo
- installation</para>
+ <para><?xxe-sn 2ba2e84701s 1g?>CLINGO_PATH Installed Clingo
+ directory</para>
+
+ <remark><?xxe-sn 2ccp2iy80zj 1td6aqezxvj7r?>"Directory of Clingo
+ installation": может, with Clingo installation? (это если речь идет о
+ папке, где хранятся инсталляционные файлы) Если наоборот, куда будет
+ устанавливаться - тогда Directory for installing Clingo. Оригинальный
+ вариант ("of Clingo installation") немного сбивает с толку.</remark>
</listitem>
</itemizedlist>
</section>
</chapter>
diff --git a/documentation/manual.json b/documentation/manual.json
new file mode 100644
index 0000000..f2ed4b0
--- /dev/null
+++ b/documentation/manual.json
@@ -0,0 +1,35 @@
+{
+ "book": "Xreate Manual",
+ "pages":
+ [
+ {"title": "Basics", "pages": [
+ {"title": "Introduction", "slug": "/", "filename": "index.xml.remarkup", "subtitle": "General information about Xreate"},
+ {"title": "Syntax", "slug": "syntax/", "filename": "syntax.xml.remarkup", "subtitle": "Xreate syntax in detail"},
+ {"title": "Modules", "slug": "syntax/modules/", "filename": "modules.xml.remarkup", "subtitle": "How to reuse and combine existing code in Xreate"}
+ ]},
+
+ {"title": "Transcend", "pages": [
+ {"title": "Overview", "slug": "transcend/", "filename": "transcend.xml.remarkup", "subtitle": "Logic, declarative level of Xreate"},
+ {"title": "Late Transcend", "slug": "transcend/late-transcend/", "filename": "latetranscend.xml.remarkup", "subtitle": "How reasoning is able to work at runtime"}
+ ]},
+
+ {"title": "Concepts", "pages": [
+ {"title": "Polymorphism", "slug": "concepts/polymorphism/", "filename": "polymorphism.xml.remarkup", "subtitle": "Let logic inference choose how program would behave at runtime"},
+ {"title": "Context", "slug": "concepts/context/", "filename": "context.xml.remarkup", "subtitle": "How to capture and use information about control flow and hierachy within program"},
+ {"title": "Interpretation", "slug": "concepts/interpretation/", "filename": "interpretation.xml.remarkup", "subtitle": "Explains compile time computations and more"}
+ ]},
+
+ {"title": "Libraries", "pages": [
+ {"title": "Containers", "slug": "concepts/containers/", "filename": "containers.xml.remarkup", "subtitle": "Automatic inference about the most apporpriate container implementation"},
+ {"title": "Communication", "slug": "communication/", "filename": "communication.xml.remarkup", "subtitle": "Safe usage of mutable as well as global variables"},
+ {"title": "Exploitation", "slug": "exploitation/", "filename": "exploitation.xml.remarkup", "subtitle": "Shared usage of the external resources - initialization and finalization"},
+ {"title": "Virtualization", "slug": "virtualization/", "filename": "virtualization.xml.remarkup", "subtitle": "Controls access to the external resources or different program's components"}
+ ]},
+
+ {"title": "Transcend APIs", "pages": [
+ {"title": "AST API", "slug": "transcend/ast-api/", "filename": "ast-api.xml.remarkup", "subtitle": ""},
+ {"title": "Latex API", "slug": "transcend/latex-api/", "filename": "latex-api.xml.remarkup", "subtitle": ""},
+ {"title": "Modules API", "slug": "transcend/modules-api/", "filename": "modules-api.xml.remarkup", "subtitle": ""}
+ ]}
+ ]
+}
diff --git a/pandoctl b/pandoctl
deleted file mode 100755
index 005ceed..0000000
--- a/pandoctl
+++ /dev/null
@@ -1,13 +0,0 @@
-#!/bin/bash
-
-case $1 in
- convert)
- Name=$(basename $2)
- sed -e '/<?xxe-revisions/, /?>/ d' -e 's/<?xxe[^?]*?>//g' $2 | \
- /opt/pandoc/dist/build/pandoc/pandoc \
- -f docbook \
- -t ./documentation-tools/doc-converter/remarkup.lua \
- -o $3/$Name.remarkup
- ;;
- *) echo "usage: $0 convert <SOURCE-FILE> <DEST-FOLDER>";;
-esac

Event Timeline

Email: pr.h7@xreate.org · 2019 Xreate.org · Powered by Phabricator