@reactwright/template-essay 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Reactwright contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,117 @@
+# @reactwright/template-essay
+
+MLA-style academic essay template for the Reactwright document engine.
+US Letter, 1" margins, Times New Roman 12pt double-spaced, first-line
+indented paragraphs, left-aligned bold section headings, hanging-
+indent Works Cited at the back.
+
+## When to use this over alternatives
+
+- Pick `@reactwright/template-essay` for single MLA-style essays,
+  undergraduate papers, term papers, or any short academic prose
+  destined for double-spaced grading-friendly output.
+- Pick `@reactwright/template-report` for technical or business
+  reports (single-spaced, decimal section numbering).
+- Pick `@reactwright/template-ieee` or
+  `@reactwright/template-ieee-report` for IEEE-branded papers.
+- Pick `@reactwright/template-book` for long-form chaptered prose
+  at trade-paperback dimensions.
+
+## Format conventions
+
+- US Letter paper, 1" margins all sides.
+- Body: Times New Roman 12pt, line-height 2.0 (double-spaced).
+- Paragraphs: 0.5" first-line indent. The first paragraph after a
+  heading is flush left (no indent).
+- Title: 14pt bold centered.
+- Author: 12pt italic centered below the title.
+- Section headings (depth 1): 12pt bold, left-aligned, no numeric
+  prefix. Headings are kept with the following paragraph (no orphan
+  heads at the bottom of a page).
+- Block quotes: 0.5" left + right indent, upright (no italic), no
+  first-line indent.
+- Inline code: monospace, no background or border.
+- Works Cited (`role="bibliography"`): heading centered bold; entries
+  with hanging indent (0.5" left margin negated by a -0.5" first-line
+  indent) and no numeric prefix.
+- Running header on page 2+: author's last name and page number, top
+  right.
+
+## Usage
+
+```tsx
+import "reactwright/jsx";
+import { Template } from "@reactwright/template-essay";
+
+export { Template };
+
+export default function MyEssay() {
+  return (
+    <document title="The Question of Method" author="A. Author">
+      <set running="author-lastname" value="Author" />
+
+      <section title="Introduction">
+        <p>
+          Open with the thesis. Subsequent paragraphs in the same
+          section pick up the 0.5" first-line indent automatically.
+        </p>
+        <p>The second paragraph indents; the first does not.</p>
+      </section>
+
+      <section title="A Closer Look">
+        <p>
+          Cite as you go <cite cite="smith2024" />. Sources resolve
+          against the <code>refs</code> block at the back of the
+          document.
+        </p>
+
+        <quote>
+          <p>
+            Block quotes are indented on both sides and lose the
+            first-line indent. Use them for long extract quotations.
+          </p>
+        </quote>
+      </section>
+
+      <section title="Conclusion">
+        <p>Wrap with a concluding paragraph.</p>
+      </section>
+
+      <refs>
+        <ref-entry refKey="smith2024">
+          Smith, A. (2024). <em>A Robust Method</em>. Publisher.
+        </ref-entry>
+      </refs>
+    </document>
+  );
+}
+```
+
+The `<set running="author-lastname" value="Author" />` line is what
+populates the top-right page-2+ header. Omit it if you do not need a
+running header.
+
+## Implementation notes
+
+Styling is expressed entirely via the styling dialect (`<styles>` +
+`<rule>`). The exported `ESSAY_STYLES` is the CSS-dialect source the
+template binds. There is no engine-bypass CSS.
+
+Section roles are not required — the template numbers nothing and
+expects unrouted top-level `<section>`s for the body. The
+`role="bibliography"` section is composed by the userland
+`<Bibliography>` helper that the template includes after the body
+slot; author-side, you provide entries via `<refs>` and the engine
+collects them.
+
+## Limitations
+
+- **MLA header block** (author, instructor, course, date stacked at
+  the top of page 1) is not built into the template. Authors who need
+  it can add a small lead-in section before the first body section,
+  or extend the template by adding a region above the body slot.
+- **Single citation style.** Cites render as bare links to the Works
+  Cited target by default; MLA parenthetical "(Author 12)" formatting
+  is not currently computed by the engine. Authors who need it can
+  hand-author the parenthetical in prose and let `<cite>` provide
+  only the anchor.

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@reactwright/template-essay",
+  "version": "0.1.0",
+  "description": "MLA-style academic essay template for the Reactwright document engine.",
+  "license": "MIT",
+  "author": "Reactwright contributors",
+  "homepage": "https://github.com/PurpleReverie/reactwright/tree/main/packages/template-essay#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PurpleReverie/reactwright.git",
+    "directory": "packages/template-essay"
+  },
+  "bugs": {
+    "url": "https://github.com/PurpleReverie/reactwright/issues"
+  },
+  "keywords": ["reactwright", "template", "essay", "academic", "mla"],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "files": [
+    "src",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "check": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "reactwright": "workspace:*",
+    "react": "^18 || ^19"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.18",
+    "@types/react": "^19.1.2",
+    "react": "^19.1.0",
+    "reactwright": "workspace:*",
+    "typescript": "^5.8.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+// MLA-style essay helper package. Exports a single Template plus the
+// raw styles string so authors can compose it into their own templates.
+export { Template, ESSAY_STYLES } from "./template.js";

package/src/template.tsx

@@ -0,0 +1,220 @@
+import "reactwright/jsx";
+import { Bibliography } from "../../reactwright/src/userland/Bibliography.js";
+
+// MLA-style academic essay template, packaged as a reusable module.
+// Templates that want the same essay styling can:
+//
+//   import { Template, ESSAY_STYLES } from "./essay";
+//
+// Rules captured:
+//   • US Letter paper, 1" margins all around
+//   • Body: Times New Roman 12pt, line-height 2.0 (double-spaced)
+//   • Paragraphs: 0.5em first-line indent
+//   • Title: 14pt bold centered; Author: italic centered below
+//   • Section headings: 12pt bold, left-aligned, NO numbering
+//   • Block quotes: indented 0.5", upright (no italic)
+//   • Running header on page 2+: lastname + page number, right-aligned
+//   • Works Cited: hanging indent, no numeric prefix
+//
+// Slice-1+ dialect only. customCss is empty.
+
+export const ESSAY_STYLES = `
+  .essay-title {
+    font-size: 14pt;
+    font-weight: bold;
+    font-family: 'Times New Roman', Times, serif;
+    text-align: center;
+    margin: 0 0 4pt 0;
+    line-height: 1.2;
+    text-indent: 0;
+  }
+
+  .essay-author {
+    font-size: 12pt;
+    font-style: italic;
+    font-weight: normal;
+    text-align: center;
+    margin: 0 0 12pt 0;
+    text-indent: 0;
+  }
+
+  .essay-section-head {
+    font-size: 12pt;
+    font-weight: bold;
+    font-family: 'Times New Roman', Times, serif;
+    text-align: left;
+    text-transform: none;
+    letter-spacing: 0;
+    margin: 12pt 0 0 0;
+    text-indent: 0;
+    break: after(avoid);
+  }
+
+  .essay-body-p {
+    margin: 0;
+    text-indent: 0.5in;
+    text-align: left;
+  }
+
+  .essay-heading-adjacent-p {
+    text-indent: 0;
+  }
+
+  .essay-blockquote {
+    margin: 6pt 0.5in;
+    font-style: normal;
+    text-indent: 0;
+  }
+
+  .essay-blockquote-p {
+    margin: 0;
+    text-indent: 0;
+    text-align: left;
+  }
+
+  .essay-bibliography {
+    font-size: 12pt;
+    margin-top: 18pt;
+  }
+
+  .essay-bib-heading {
+    font-size: 12pt;
+    font-weight: bold;
+    font-style: normal;
+    text-align: center;
+    margin: 0 0 6pt 0;
+    text-indent: 0;
+    break: after(avoid);
+  }
+
+  .essay-bib-list {
+    list-style: none;
+    padding-left: 0;
+    margin: 0;
+  }
+
+  .essay-bib-entry {
+    margin-bottom: 0;
+  }
+
+  .essay-bib-entry-p {
+    margin: 0;
+    text-align: left;
+    text-indent: -0.5in;
+    padding-left: 0.5in;
+  }
+
+  .essay-cite {
+    color: inherit;
+    text-decoration: none;
+  }
+
+  .essay-code-inline {
+    background: none;
+    padding: 0;
+    border-radius: 0;
+    font-family: 'SFMono-Regular', Consolas, Menlo, monospace;
+    font-size: 0.92em;
+  }
+`;
+
+export function Template() {
+  return (
+    <page
+      page={{
+        size: "letter",
+        marginTop: "1in",
+        marginBottom: "1in",
+        marginLeft: "1in",
+        marginRight: "1in"
+      }}
+      typography={{
+        fontFamily: "'Times New Roman', Times, serif",
+        fontSize: "12pt",
+        lineHeight: 2.0,
+        textAlign: "left"
+      }}
+    >
+      <styles>{ESSAY_STYLES}</styles>
+
+      <rule match={{ kind: "title" }} className="essay-title" />
+      <rule match={{ kind: "author" }} className="essay-author" />
+      <rule match={{ kind: "code" }} className="essay-code-inline" />
+
+      {/* Section headings — depth 1 only, exclude bibliography heading */}
+      <rule
+        match={{
+          kind: "section-heading",
+          depth: 1,
+          not: { within: { kind: "section", role: "bibliography" } }
+        }}
+        className="essay-section-head"
+      />
+
+      {/* Body paragraphs everywhere except blockquote + bibliography */}
+      <rule
+        match={{
+          kind: "paragraph",
+          not: {
+            or: [
+              { within: { kind: "section", role: "bibliography" } },
+              { within: { kind: "blockquote" } }
+            ]
+          }
+        }}
+        className="essay-body-p"
+      />
+
+      {/* First paragraph after a heading is flush left (no indent) */}
+      <rule
+        match={{ kind: "paragraph", follows: { kind: "section-heading" } }}
+        className="essay-heading-adjacent-p"
+      />
+
+      {/* Block quotes — left/right indented, no italic, no first-line indent */}
+      <rule match={{ kind: "blockquote" }} className="essay-blockquote" />
+      <rule
+        match={{ kind: "paragraph", within: { kind: "blockquote" } }}
+        className="essay-blockquote-p"
+      />
+
+      {/* Cites: plain author-style — no [N] bracket; rely on the bib
+          target ID instead. The default engine cite suffix is a [N]
+          counter via target-counter, which we override here with
+          empty prefix/suffix so author may insert their own. */}
+      <rule match={{ kind: "cite" }} className="essay-cite" />
+
+      {/* Works Cited (userland Bibliography emits a section role="bibliography"). */}
+      <rule match={{ kind: "section", role: "bibliography" }} className="essay-bibliography" />
+      <rule
+        match={{ kind: "section-heading", within: { kind: "section", role: "bibliography" } }}
+        className="essay-bib-heading"
+      />
+      <rule
+        match={{ kind: "list", within: { kind: "section", role: "bibliography" } }}
+        className="essay-bib-list"
+      />
+      <rule
+        match={{ kind: "item", within: { kind: "section", role: "bibliography" } }}
+        className="essay-bib-entry"
+      />
+      <rule
+        match={{ kind: "paragraph", within: { kind: "section", role: "bibliography" } }}
+        className="essay-bib-entry-p"
+      />
+
+      <header anchor="top-right" when="not-first-page" typography={{ fontSize: "12pt" }}>
+        <running name="author-lastname" /> <page-number />
+      </header>
+
+      <stack gap="0">
+        <region>
+          <slot name="title" />
+          <slot name="author" />
+          <slot name="body" />
+          <Bibliography title="Works Cited" />
+        </region>
+      </stack>
+    </page>
+  );
+}