Module Tools.MakeDocIndex

Inspect a frege documentation directory and make files that enable framed HTML view.

Imports

• import Data.List as List
• import Java.Net as Net
• import frege.Prelude as Prelude
• import Prelude.PreludeArrays as PreludeArrays
• import Prelude.PreludeBase as PreludeBase
• import Prelude.PreludeDecimal as PreludeDecimal
• import Prelude.PreludeIO as PreludeIO
• import Prelude.PreludeList as PreludeList
• import Prelude.PreludeMonad as PreludeMonad
• import Prelude.PreludeText as PreludeText
• import Java.util.Regex as Regexp

Table of Content

• Definitions

  separatorRE ∷ Regex

  htmlAtEnd ∷ Regex

  unHtml ∷ String → String

  isMeta ∷ String → Bool

  findHtml ∷ String → IO [(String, String)]

  main ∷ [String] → IO Bool

  printFregeDoc ∷ String → IO ()

  fileIn ∷ String → String → IO String

  makePrefixFrame ∷ String → [String] → IO ()

  makeFrame ∷ String → String → [(String, String)] → IO ()

  wrap ∷ String → String → String

  linkElem ∷ String → String → String

  frameElem ∷ String → String

  prefixName ∷ String → String

  prefixFrame ∷ String → String

• Functions and Values by Type

Definitions

separatorRE ∷ Regex

regular expression to split path names on File.separator

htmlAtEnd ∷ Regex

regular expression to detect "*.html" files

unHtml ∷ String → String

drop ".html" from the end of a name

isMeta ∷ String → Bool

tell if this is the name of a meta file

findHtml ∷ String → IO [(String, String)]

walk a directory and get all HTML files

main ∷ [String] → IO Bool

We will make the following files:

fregedoc.html defines 3 frames: left upper, left lower and right.

prefix-frame.html contains a list of the module prefixes, which are shown in the left upper frame. Each entry causes the left lower frame to display the modules with that prefix.

For each module prefix a file that lists the actual modules. This one is displayed in the left lower frame, and clicking on one of the names causes the module documentation to appear in the right frame. For example, frame-frege.prelude.html would contain PreludeBase, PreludeMonad and so on.

There will be a pseudo module prefix "All Modules" and a corresponding frame-All-Modules.html that contains links to all the modules.

printFregeDoc ∷ String → IO ()

Print the top file with the frameset

fileIn ∷ String → String → IO String

compute the path of a file in a certain directory

makePrefixFrame ∷ String → [String] → IO ()

make the prefix-frame.html file

makeFrame ∷ String → String → [(String, String)] → IO ()

wrap ∷ String → String → String

wrap in html tags, i.e. <xx>foo</xx>

linkElem ∷ String → String → String

make link from a relative path and a HTML file name

frameElem ∷ String → String

make link to frame

prefixName ∷ String → String

display name of a module prefix

prefixFrame ∷ String → String

file name of a module prefix

Functions and Values by Type

String → String → [(String, String)] → IO ()

makeFrame

String → String → IO String

fileIn

String → String → String

linkElem, wrap

String → [String] → IO ()

makePrefixFrame

String → IO [(String, String)]

findHtml

String → IO ()

printFregeDoc

String → String

frameElem, prefixFrame, prefixName, unHtml

String → Bool

isMeta

[String] → IO Bool

main

Regex

htmlAtEnd, separatorRE