's,
etc.--JSON export is hoped for the future).
- Ease of navigation within a site (as via breadcrumbs) and accessibility
(e.g., for the visually impaired) is also desired, but we are hoping
for expertise to provide a review and ideally assistance. We do have
some code begun internally.

The following are administrator-facing features/goals:

- Allow most functionality to work for administrators out of the box via a
declarative style (via well-used and readable JSON files) without need
for custom scripting. Though the project originated to meet the need of
Bahá'í texts, any document and even data with sequential fields
that can be put into a tabular structure can be browsed.
- Allow for translations within separate locale files
- Allows for easy conversion of table structures (e.g., SQL, JSON) into our
simple JSON array format
- Allow for standard means (as with our use of
JSON Schema)
to designate type information that can be used by the program for
automated display as well as optimization. Where a standard means
does not exist, we provide a declarative meta-data file to house
this information.
- It is a goal for us to support plug-ins for extensibility, including
declarative specification without need for scripting, but such support
is currently lacking (though some work internally has begun).
- It is a goal for us to support declarative means for indicating site
hierarchy and navigation. This is not implemented, but we do have some
code begun internally.

The following are third-party-site-facing features/goals:

- The thorough use of query strings (even to customize the work selection
page as well as the results page) allow for other tools to more easily
tap into our API, and the control of styling (including of whether to show
table headers) deliberately allows for third-party sites to embed
content directly from TextBrowser-driven sites (including sites which
might wish to provide up-to-date, proofread, canonical sources of data
without duplicating or introducing the possibility of copy-paste error).
Blogs, discussion forums, and wikis might, for example, provide widgets
(a popup to our site especially once we may have implemented our to-do
for canonical syntax selection available through postMessage?) which
could be used to embed a specific range and/or styling of text in a post.
These advantages of widely-used query strings also go for people sharing
links or bookmarking for themselves.

The following are TextBrowser-developer-facing features/goals:

- Strong separation of concerns, with "design logic" separate from
"business logic". We are using Jamilih-based
templating to allow for templating functions in Vanilla JavaScript (as
well as avoiding ugly, angular HTML almost entirely!). While the results
display for users leverages CSS classes, we still need to remove some
inline styling for better structural (HTML) vs. styling (CSS) separation.
- We aim to leverage modern syntax, especially JavaScript, allowing
derivative projects to polyfill if they wish to support older browsers.
Besides aiming for better forward-compatibility, this allows us to use
standard, well-known patterns, as well as more readable, succinct code.
- We hope for good test-driven development, but currently this is limited to
schema validation. We are still in need of a choice of UI testing
framework and tests (as well as for unit tests).

Installation

The repository is intended to be used as a
npm dependency.

Run the following from your project root.

``install
npm install textbrowser --save
`

Usage

The following instructions are aimed at those adding TextBrowser as a
dependency of their own project.

If you would like to see a sample package implementing the
following, see the
bahai-browser
project or for a project just implementing the JSON files, see
bahaiwritings.

Projects derivative to TextBrowser will need to adhere to the following:

1. Add the TextBrowser dependency per the Installation
section.

1. Prepare JSON data files, JSON Schema files, and JSON meta-data files
to represent your texts. See the section
JSON Formats.
To provide a common naming mechanism across projects and to avoid
the need to tweak the default TextBrowser JavaScript class set-up, a
specific directory structure
is recommended for hosting these files.

1. Prepare JSON files to indicate the specific grouping of files you wish
to make available and optionally the interface languages you wish to
make available (and for which you have locales), and after it may be
ready, and if you wish, the JSON files to indicate your site hierarchy.
See the
recommended directory structure
section for more.

1. Create an HTML page (see index-sample.html for an example) which includes
TextBrowser's own project scripts and your own script to instantiate
the TextBrowser class (and if you did not follow the
recommended directory structure,
you will need to point to the above-mentioned JSON
files). Page titles are set dynamically for each page, so there is no
need to provide a