hets -- a heterogenous Specification (CASL) tool setContentsIndex
Common.LaTeX_funs
Portability portable
Stability provisional
Maintainer hets@tzi.de
Description

Functions to calculate the length of a given word as it would be printed with LaTeX according to one of four categories of words useful for CASL:

  • keywords -- all the things that were printed in boldface
  • structid -- all the names used in the structured context of CASL
  • annotation -- all the comments and annotations of CASL in a smaller font
  • axiom -- identifiers in math mode for CASL Basic specs

TODO: - itCorrection should be based on a map of character pairs to corrections and not on one fixed value for every pair

Synopsis
space_latex_width :: Int
calc_line_length :: String -> Int
pt_length :: Int -> String
keyword_width :: String -> Int
structid_width :: String -> Int
axiom_width :: String -> Int
annotation_width :: String -> Int
annotationbf_width :: String -> Int
comment_width :: String -> Int
normal_width :: String -> Int
escape_latex :: String -> String
escape_comment_latex :: String -> String
(<\+>) :: Doc -> Doc -> Doc
(<~>) :: Doc -> Doc -> Doc
latex_macro :: String -> Doc
comma_latex :: Doc
semi_latex :: Doc
colon_latex :: Doc
equals_latex :: Doc
space_latex :: Doc
braces_latex :: Doc -> Doc
parens_latex :: Doc -> Doc
brackets_latex :: Doc -> Doc
quotes_latex :: Doc -> Doc
nest_latex :: Int -> Doc -> Doc
hang_latex :: Doc -> Int -> Doc -> Doc
sep_latex :: [Doc] -> Doc
fsep_latex :: [Doc] -> Doc
initial_keyword_latex :: String -> String -> Doc
casl_keyword_latex :: String -> Doc
casl_annotation_latex :: String -> Doc
casl_annotationbf_latex :: String -> Doc
casl_axiom_latex :: String -> Doc
casl_comment_latex :: String -> Doc
casl_structid_latex :: String -> Doc
casl_normal_latex :: String -> Doc
hc_sty_keyword :: Maybe String -> String -> Doc
hc_sty_small_keyword :: String -> Doc
hc_sty_plain_keyword :: String -> Doc
hc_sty_hetcasl_keyword :: String -> Doc
hc_sty_comment :: Doc -> Doc
hc_sty_annotation :: Doc -> Doc
hc_sty_axiom :: String -> Doc
hc_sty_structid :: String -> Doc
hc_sty_structid_indexed :: String -> Doc
hc_sty_id :: String -> Doc
startAnno :: String
endAnno :: String
Documentation
space_latex_width :: Int
calc_line_length :: String -> Int
pt_length :: Int -> String
keyword_width :: String -> Int
structid_width :: String -> Int
axiom_width :: String -> Int
annotation_width :: String -> Int
annotationbf_width :: String -> Int
comment_width :: String -> Int
normal_width :: String -> Int
escape_latex :: String -> String
escape_comment_latex :: String -> String
(<\+>) :: Doc -> Doc -> Doc
LaTeX version of + with enough space counted. It's choosen the space between keywords which is nearly the average width of a space.
(<~>) :: Doc -> Doc -> Doc
latex_macro :: String -> Doc
latex_macro creates a document (Doc) containing String that has a zero width. So it can be used for LaTeX-macros not needing any space, i.e. textit{ or }
comma_latex :: Doc
semi_latex :: Doc
colon_latex :: Doc
equals_latex :: Doc
space_latex :: Doc
braces_latex :: Doc -> Doc
parens_latex :: Doc -> Doc
brackets_latex :: Doc -> Doc
quotes_latex :: Doc -> Doc
nest_latex :: Int -> Doc -> Doc
hang_latex :: Doc -> Int -> Doc -> Doc
sep_latex :: [Doc] -> Doc
fsep_latex :: [Doc] -> Doc
initial_keyword_latex :: String -> String -> Doc
casl_keyword_latex :: String -> Doc
casl_annotation_latex :: String -> Doc
casl_annotationbf_latex :: String -> Doc
casl_axiom_latex :: String -> Doc
casl_comment_latex :: String -> Doc
casl_structid_latex :: String -> Doc
casl_normal_latex :: String -> Doc
hc_sty_keyword :: Maybe String -> String -> Doc
hc_sty_small_keyword :: String -> Doc
hc_sty_plain_keyword :: String -> Doc
hc_sty_hetcasl_keyword :: String -> Doc
hc_sty_comment :: Doc -> Doc
hc_sty_annotation :: Doc -> Doc
hc_sty_axiom :: String -> Doc
hc_sty_structid :: String -> Doc
hc_sty_structid_indexed :: String -> Doc
hc_sty_id :: String -> Doc
startAnno :: String
a constant String for the start of annotations
endAnno :: String
a constant string ending an annotation
Produced by Haddock version 0.6