{"size": 1177, "ext": "scrbl", "max_stars_repo_path": "share/pkgs/simple-tree-text-markup-doc/scribblings/simple-tree-text-markup/simple-tree-text-markup.scrbl", "max_stars_repo_name": "takikawa/racket-ppa", "max_stars_repo_stars_event_min_datetime": "2018-07-29T04:13:52.000Z", "max_stars_repo_stars_event_max_datetime": "2022-02-14T16:11:17.000Z", "max_issues_repo_path": "share/pkgs/simple-tree-text-markup-doc/scribblings/simple-tree-text-markup/simple-tree-text-markup.scrbl", "max_issues_repo_name": "takikawa/racket-ppa", "max_issues_repo_issues_event_min_datetime": "2017-08-25T20:26:37.000Z", "max_issues_repo_issues_event_max_datetime": "2022-02-26T17:48:40.000Z", "max_forks_repo_path": "share/pkgs/simple-tree-text-markup-doc/scribblings/simple-tree-text-markup/simple-tree-text-markup.scrbl", "max_forks_repo_name": "takikawa/racket-ppa", "max_forks_repo_forks_event_min_datetime": "2021-07-26T00:31:14.000Z", "max_forks_repo_forks_event_max_datetime": "2021-10-09T05:02:43.000Z"}
{"max_stars_count": 10, "max_issues_count": 15, "max_forks_count": 2, "avg_line_length": 36.78125, "max_line_length": 92, "alphanum_fraction": 0.7918436703}
#lang scribble/doc

@(require scribble/manual)

@title[#:style '(toc)]{Simple Tree Text Markup: Simple Markup for Display as Text or in GUI}

@author["Mike Sperber"]

This is a tree-based combinator library for simple markup, mainly for
displaying messages in a REPL. It features horizontal and vertical
composition as well as framed markup.  Its main distinguishing feature
is its ability to embed source locations, which can be rendered as
links.

This package comes with separate modules for @emph{inspecting} and
@emph{constructing} markup -
@racketmodname[simple-tree-text-markup/data] and
@racketmodname[simple-tree-text-markup/construct], respectively.
Markup can also be constructed through a custom output port,
supplied by @racketmodname[simple-tree-text-markup/port].

There's also a module @racketmodname[simple-tree-text-markup/text]
that renders markup to text.  Rendering markup to GUI is quite
context-specific.  Hence, the code for rendering to GUIs is
implemented with specific applications, such as DrRacket or the test
engine.

@include-section["data.scrbl"]
@include-section["construct.scrbl"]
@include-section["text.scrbl"]
@include-section["port.scrbl"]
