Grant Language Preflight (Transparent Catalog Edition)

An offline-first, single-file browser tool that highlights configured terms in proposal text and (optionally) shows rephrase / reframe suggestions with evidence notes and citations.

This repository is designed for GitHub Pages hosting and for transparent catalog maintenance (PR reviewable, versionable, and citable).

Current tool release: 2.2.0. The current catalog interchange format is format v3; the tool release and catalog format are versioned independently. Historical format-v2 exports remain import-compatible and are upgraded to v3.

---

What this is (and is not)

This tool is a writing aid. It helps you:

• identify jargon and high-salience terms,
• replace abstract labels with operational, measurable language, and
• keep a record of why a suggestion exists (rationale) and what sources support the general principle (citations).

This tool is not:

• legal advice,
• an official list of “banned words,”
• a mechanism to misrepresent eligibility, populations, methods, or outcomes.

If a solicitation/FOA requires specific statutory language, use it.

Any example text (including the "Load Example" content in the UI) is entirely AI-generated for demonstration only; any resemblance to actual projects, proposals, people, or institutions is purely coincidental.

---

Quick start (local)

1. Open docs/index.html in a modern browser.
2. Paste text into Source Text.
3. Toggle:
   • Show remessaging suggestions
   • Remember pasted text (local) (optional)
4. Use Download JSON / Upload JSON in the Catalog panel to manage your term list.

When no custom override is active, the maintained catalog.default.json is checked on each startup. An explicitly uploaded catalog becomes a persistent local override and takes precedence until you use Reset. Reset removes that override and returns to the newest bundled default available to the page. If the bundled file cannot be fetched (for example, when opening index.html directly without a local web server), the app uses its embedded default copy.

---

Publish on GitHub Pages (recommended)

This repo is configured to publish from the /docs folder.

1. Create a new GitHub repository and upload the contents of this zip.
2. In GitHub:
   • Settings → Pages
   • Source: Deploy from a branch
   • Branch: main
   • Folder: /docs
3. Save. Your site will be available at your GitHub Pages URL.

(See GitHub documentation on configuring a publishing source for Pages.)

---

Catalog transparency model

The catalog is stored at:

• docs/catalog.default.json — the default term catalog (format v3)
• docs/catalog.schema.json — JSON Schema for validation

Each maintained catalog row includes:

• id (a stable row identifier)
• keywords (semicolon-separated tokens/phrases)
• tier ("1" or "2")
• rephrase and reframe
• source (provenance, not an agency determination)
• evidenceLevel (Official policy / FOA, Style guidance, or Heuristic)
• evidence (a narrative note) and rationale
• citations (array of {title, url, note})

evidenceLevel and evidence serve different purposes: the former is a controlled classification, while the latter explains the basis and limitations of a row. In the maintained catalog, a link to general NIH or NSF policy does not by itself make a term-specific row Official policy / FOA.

Format-v3 imports preserve methodology, extension metadata, and row IDs. Downloads refresh the export-managed exportedAt, tool, and toolVersion fields while retaining other top-level metadata. Historical format-v2 files exported by earlier releases are migrated to v3 on import; if they contain duplicate effective triggers, the earliest row retains ownership and later duplicate occurrences are removed. Citation links must use http: or https:.

Editing workflow

1. Download catalog JSON in the app (Catalog → Download JSON), or edit docs/catalog.default.json directly.
2. Validate against docs/catalog.schema.json and run the repository checks described in CONTRIBUTING.md.
3. Commit changes with a clear message and update CHANGELOG.md for notable edits.

For normal users, a custom upload is intentionally isolated in browser localStorage; it does not modify the repository’s maintained catalog.

---

Licenses & citation

• Code license: MIT (LICENSE)
• Catalog data license: CC BY 4.0 (DATA_LICENSE.md)

---

Compliance and copyright notes (practical)

• Citations increase transparency but do not grant permission to copy third‑party wording or tables.
• Avoid re-hosting third-party PDFs unless you have permission; link instead.
• Keep all proposal statements true, complete, and accurate.

See SOURCES.md for the small set of reference links used as general support for the writing approach.

---

Support / contributions

See CONTRIBUTING.md.