apex-ruby 1.0.30 → 1.0.31

data/ext/apex_ext/apex_src/documentation/README.md

@@ -1,160 +0,0 @@
-# Apex Documentation Generators
-
-This directory contains scripts to generate documentation from the Apex wiki.
-
-## Scripts
-
-### `generate_docset.rb`
-
-Generates Dash docsets for Apex documentation.
-
-**Usage:**
-```bash
-./generate_docset.rb [single|multi]
-```
-
-- `single` - Generate single-page CLI options docset (ApexCLI.docset)
-- `multi` - Generate multi-page docset from wiki files (Apex.docset, default)
-
-**Output:**
-- Docsets are generated in `docsets/` directory
-- The script automatically clones the wiki from GitHub and cleans up after running
-
-### `generate_single_html.rb`
-
-Generates a single HTML file with all wiki pages, using JavaScript to show/hide pages.
-
-**Usage:**
-```bash
-./generate_single_html.rb
-```
-
-**Output:**
-- HTML file is generated in `html/apex-docs.html`
-- The script automatically clones the wiki from GitHub and cleans up after running
-
-### `generate_app_docs.rb`
-
-Generates app-focused documentation from pre-transformed Markdown files. This script reads from `app-transformed/` and generates a single HTML file suitable for embedding in apps like Marked.app.
-
-**Usage:**
-```bash
-./generate_app_docs.rb
-```
-
-**Output:**
-- HTML file is generated in `html/apex-app-docs.html`
-- Settings table is generated in `app-settings-table.md`
-- Uses pre-transformed files from `app-transformed/` directory
-
-**Note:** This script requires pre-transformed Markdown files. See "AI Transformation Workflow" below for how to create them.
-
-### `generate_app_docs_ai.rb`
-
-Uses AI (via cursor-agent or similar) to transform CLI-focused documentation into app-focused documentation. This script can automatically transform wiki pages by replacing CLI references with app Settings references.
-
-**Usage:**
-```bash
-./generate_app_docs_ai.rb
-```
-
-**Requirements:**
-- `cursor-agent` or similar AI agent tool
-- `transform_for_app.md` file (copy from `transform_for_app.example.md`)
-
-**Output:**
-- Transformed Markdown files in `app-transformed/` directory
-- HTML file is generated in `html/apex-app-docs.html`
-- Settings table is generated in `app-settings-table.md`
-
-**Note:** This script requires manual setup. See "AI Transformation Workflow" below.
-
-## Requirements
-
-- Ruby
-- Apex binary (in PATH or in `../build-release/apex`)
-- `sqlite3` gem (for multi-page docset): `gem install sqlite3`
-- `mmd2cheatset` (for single-page docset): Should be at `~/Desktop/Code/mmd2cheatset/mmd2cheatset.rb`
-- Git (for cloning the wiki)
-
-## Directory Structure
-
-```
-documentation/
-├── generate_docset.rb           # Dash docset generator
-├── generate_single_html.rb      # Single HTML file generator
-├── generate_app_docs.rb         # App docs generator (uses pre-transformed files)
-├── generate_app_docs_ai.rb      # AI-powered app docs transformer
-├── transform_for_app.example.md # Example transformation instructions
-├── docsets/                     # Generated docsets (gitignored)
-│   ├── Apex.docset
-│   └── ApexCLI.docset
-├── html/                        # Generated HTML files (gitignored)
-│   ├── apex-docs.html
-│   └── apex-app-docs.html
-├── app-transformed/             # Transformed Markdown files (gitignored)
-│   ├── Syntax.md
-│   ├── Modes.md
-│   ├── Plugins.md
-│   └── ...
-└── app-settings-table.md        # Generated settings reference table
-```
-
-## How It Works
-
-### Standard Documentation Generation
-
-The standard scripts (`generate_docset.rb` and `generate_single_html.rb`):
-1. Clone the wiki from `https://github.com/ApexMarkdown/apex.wiki.git` into `apex.wiki/`
-2. Process the wiki files
-3. Generate the output
-4. Clean up by removing the cloned wiki directory
-
-This ensures the latest version of the wiki is always used and no local wiki clone is required.
-
-### AI Transformation Workflow
-
-The app-focused documentation uses a hybrid approach:
-
-1. **Manual Transformation (Recommended)**
-   - Copy `transform_for_app.example.md` to `transform_for_app.md`
-   - Edit `transform_for_app.md` to match your app's settings structure
-   - Manually transform wiki pages using the instructions in `transform_for_app.md`
-   - Save transformed files to `app-transformed/` directory
-   - Run `generate_app_docs.rb` to generate the HTML
-
-2. **AI-Powered Transformation (Experimental)**
-   - Copy `transform_for_app.example.md` to `transform_for_app.md`
-   - Edit `transform_for_app.md` if needed for your app
-   - Ensure `cursor-agent` or similar AI tool is available
-   - Run `generate_app_docs_ai.rb` to automatically transform files
-   - Review and edit the generated files in `app-transformed/` as needed
-   - Run `generate_app_docs.rb` to generate the HTML
-
-**Transformation Instructions:**
-
-The `transform_for_app.example.md` file contains comprehensive instructions for transforming CLI-focused documentation to app-focused documentation. Key transformations include:
-
-- Replace CLI flags (`--flag`) with Settings references (`Settings->Category->Setting Name`)
-- Remove command-line examples (code blocks showing `apex` commands)
-- Remove links to "Command Line Options" page
-- Add app-specific instructions (e.g., "Marked will automatically detect...")
-- Page-specific transformations for Multi-File-Documents, Plugins, Modes, etc.
-
-**Example:**
-
-**Before (CLI-focused):**
-> Use the `--plugins` flag to enable plugins:
->
-> ```bash
-> apex document.md --plugins
-> ```
-
-**After (App-focused):**
-> Enable plugins by checking **Settings->Processor->Include Plugins**.
-
-**Important Notes:**
-
-- The `app-transformed/` directory and `transform_for_app.md` are gitignored
-- This allows you to maintain app-specific documentation without committing it to the public repo
-- The example file (`transform_for_app.example.md`) is tracked in git as a template

data/ext/apex_ext/apex_src/documentation/app-settings-table.md

@@ -1,67 +0,0 @@
-# Apex App Settings Reference
-
-This document lists all Settings referenced in the app-focused documentation that would need to be implemented in the Apex app.
-
-## Settings Structure
-
-### General
-
-| Setting | Type | Description |
-|---------|------|-------------|
-
-
-### Processor
-
-| Setting | Type | Description |
-|---------|------|-------------|
-| Settings->Processor** | Varies | Configure settings->processor** |
-| Settings->Processor**. | Varies | Configure settings->processor**. |
-| Alpha | Varies | Configure alpha |
-| Autolinks** | Varies | Configure autolinks** |
-| CSL | Varies | Configure csl |
-| Citations** | Varies | Configure citations** |
-| Citations**, | Varies | Configure citations**, |
-| Citations**. | Varies | Configure citations**. |
-| Combine | Varies | Configure combine |
-| Critic | Varies | Configure critic |
-| Fenced | Varies | Configure fenced |
-| Footnotes** | Varies | Configure footnotes** |
-| Generate | Varies | Configure generate |
-| Header | Varies | Configure header |
-| Include | Varies | Configure include |
-| Link | Varies | Configure link |
-| MMD | Varies | Configure mmd |
-| Math | Varies | Configure math |
-| Metadata | Varies | Configure metadata |
-| Mixed | Varies | Configure mixed |
-| Mode**. | Varies | Configure mode**. |
-| Superscript/Subscript**. | Varies | Configure superscript/subscript**. |
-| Suppress | Varies | Configure suppress |
-| Table | Varies | Configure table |
-| Wiki | Varies | Configure wiki |
-
-### Output
-
-| Setting | Type | Description |
-|---------|------|-------------|
-
-
-
-
-
-## Menu Items
-
-| Menu Item | Location | Description |
-|-----------|---------|-------------|
-| Plugins menu | Main menu | Access plugins menu |
-| Help menu | Main menu | Access help menu |
-| About window | Main menu | Access about window |
-
-## Notes
-
-- Settings should be organized in a Settings window with the structure: **Settings->Category->Setting Name**
-- Boolean settings (checkboxes/toggles) should have clear on/off states
-- File selection settings should provide a file picker dialog
-- Text input settings should have appropriate validation
-- Settings should be saved per-document or globally (user preference)
-

data/ext/apex_ext/apex_src/documentation/app-transformed/Citations.md

@@ -1,340 +0,0 @@
-# Citations and Bibliography
-
-Apex supports citations and bibliographies with multiple syntax styles and bibliography formats. Citations are processed in **MultiMarkdown** and **unified** modes.
-
-## Quick Start
-
-**1. Create a bibliography file:**
-
-Create a BibTeX file (`references.bib`):
-```bibtex
-@article{doe99,
-  author = {Doe, John},
-  title = {Article Title},
-  journal = {Journal Name},
-  year = {1999},
-  volume = {1},
-  pages = {1--10}
-}
-
-@book{smith2000,
-  author = {Smith, Jane},
-  title = {Book Title},
-  publisher = {Publisher},
-  year = {2000}
-}
-```
-
-**2. Add citations to your document:**
-
-```markdown
----
-bibliography: references.bib
----
-
-See [@doe99] for details. Smith discusses this in [@smith2000].
-
-## References
-
-<!-- REFERENCES -->
-```
-
-**3. Configure in Marked:**
-
-You can add bibliography files to a list in **Settings->Processor->Citations**, or specify them in document metadata (as shown above). When you open a document with citations, Apex will automatically process them using the configured bibliography files.
-
-## Citation Syntaxes
-
-Apex supports three citation syntax styles, automatically detected in unified mode:
-
-### Pandoc Syntax
-
-Pandoc-style citations use square brackets with `@` prefix:
-
-**Basic citation:**
-```markdown
-See [@doe99] for details.
-```
-
-**Multiple citations:**
-```markdown
-See [@doe99; @smith2000; @smith2004] for more information.
-```
-
-**Author in text:**
-```markdown
-@smith04 says blah.
-```
-
-**Author suppressed (year only):**
-```markdown
-Smith says blah [-@smith04].
-```
-
-**With locator (page numbers):**
-```markdown
-@smith04 [p. 33] says blah.
-See @doe99, pp. 33-35 and *passim*.
-```
-
-**Output:**
-```html
-<p>See <span class="citation" data-cites="doe99">(Doe, John 1999)</span> for details.</p>
-<p>See <span class="citation" data-cites="doe99 smith2000 smith2004">(Doe, John 1999; Smith, Jane 2000, 2004)</span> for more information.</p>
-<p><span class="citation" data-cites="smith04">Smith, John (2004)</span> says blah.</p>
-<p>Smith says blah <span class="citation" data-cites="smith04">(2004)</span>.</p>
-```
-
-### MultiMarkdown Syntax
-
-MultiMarkdown-style citations use `#` prefix:
-
-**Basic citation:**
-```markdown
-This is a statement[#Doe:2006].
-```
-
-**With locator:**
-```markdown
-This is a statement[p. 23][#Doe:2006].
-```
-
-**Empty locator:**
-```markdown
-This is a statement[][#Doe:2006].
-```
-
-**Inline citation:**
-```markdown
-As per Doe.[#John Doe. *A Totally Fake Book 1*. Vanity Press, 2006.]
-```
-
-**Output:**
-```html
-<p>This is a statement<span class="citation" data-cites="Doe:2006">(Doe:2006)</span>.</p>
-<p>This is a statement[p. 23]<span class="citation" data-cites="Doe:2006">(Doe:2006)</span>.</p>
-```
-
-### mmark Syntax
-
-mmark-style citations use `@` prefix (similar to Pandoc but with different conventions):
-
-**Basic citation:**
-```markdown
-This references [@RFC2535].
-```
-
-**Normative citation:**
-```markdown
-This references [@!RFC1034] (normative).
-```
-
-**Multiple citations:**
-```markdown
-Multiple citations: [@RFC1034;@RFC1035].
-```
-
-**Combined reference:**
-```markdown
-Combined reference: [@RFC1034@STD3].
-```
-
-**Output:**
-```html
-<p>This references <span class="citation" data-cites="RFC2535">(RFC2535)</span>.</p>
-<p>Multiple citations: <span class="citation" data-cites="RFC1034">(RFC1034)</span>;<span class="citation" data-cites="RFC1035">(RFC1035)</span>.</p>
-```
-
-## Bibliography Formats
-
-Apex supports three bibliography formats:
-
-### BibTeX (`.bib`)
-
-Standard BibTeX format:
-
-```bibtex
-@article{doe99,
-  author = {Doe, John},
-  title = {Article Title},
-  journal = {Journal Name},
-  year = {1999},
-  volume = {1},
-  pages = {1--10}
-}
-
-@book{smith2000,
-  author = {Smith, Jane},
-  title = {Book Title},
-  publisher = {Publisher},
-  year = {2000}
-}
-```
-
-### CSL JSON (`.json`)
-
-Citation Style Language JSON format:
-
-```json
-[
-  {
-    "id": "doe99",
-    "type": "article-journal",
-    "title": "Article Title",
-    "author": [
-      {
-        "family": "Doe",
-        "given": "John"
-      }
-    ],
-    "container-title": "Journal Name",
-    "issued": {
-      "date-parts": [[1999]]
-    },
-    "volume": "1",
-    "page": "1-10"
-  }
-]
-```
-
-### CSL YAML (`.yml`, `.yaml`)
-
-Citation Style Language YAML format:
-
-```yaml
-- id: doe99
-  type: article-journal
-  title: Article Title
-  author:
-    - family: Doe
-      given: John
-  container-title: Journal Name
-  issued:
-    date-parts:
-      - - 1999
-  volume: 1
-  page: 1-10
-```
-
-## Specifying Bibliography
-
-### Settings Configuration
-
-Add bibliography files to a list in **Settings->Processor->Citations**. These files will be available for all documents you process. You can add multiple files, and Apex will search through them when processing citations.
-
-### Document Metadata
-
-You can also specify bibliography files in document metadata, which will override or supplement the settings:
-
-**YAML front matter:**
-```markdown
----
-bibliography: references.bib
----
-
-See [@doe99] for details.
-```
-
-**Multiple files:**
-```markdown
----
-bibliography:
-  - refs1.bib
-  - refs2.bib
----
-
-See [@doe99] for details.
-```
-
-**MultiMarkdown metadata:**
-```markdown
-Bibliography: references.bib
-
-See [@doe99] for details.
-```
-
-**Pandoc title block:**
-```markdown
-% Bibliography: references.bib
-
-See [@doe99] for details.
-```
-
-## Bibliography Generation
-
-Bibliography is automatically generated from all cited entries and inserted at the `<!-- REFERENCES -->` marker:
-
-```markdown
-See [@doe99] and [@smith2000] for details.
-
-## References
-
-<!-- REFERENCES -->
-```
-
-**Output:**
-```html
-<p>See <span class="citation" data-cites="doe99">(Doe, John 1999)</span> and <span class="citation" data-cites="smith2000">(Smith, Jane 2000)</span> for details.</p>
-
-<h2>References</h2>
-<div id="refs" class="references csl-bib-body">
-<div id="ref-doe99" class="csl-entry">Doe, John 1999. <em>Article Title</em>. <em>Journal Name</em> 1: 1--10</div>
-<div id="ref-smith2000" class="csl-entry">Smith, Jane 2000. <em>Book Title</em>. Publisher</div>
-</div>
-```
-
-If no `<!-- REFERENCES -->` marker is found, the bibliography is appended to the end of the document.
-
-## Citation Options
-
-### Link Citations
-
-Enable **Settings->Processor->Link Citations** to make citations link to their bibliography entries:
-
-**Output:**
-```html
-<p>See <a href="#ref-doe99" class="citation" data-cites="doe99">(Doe, John 1999)</a> for details.</p>
-```
-
-### Suppress Bibliography
-
-Enable **Settings->Processor->Suppress Bibliography** to suppress bibliography output while still processing citations.
-
-### Citation Style (CSL)
-
-Specify a Citation Style Language file in **Settings->Processor->CSL File** to control citation and bibliography formatting.
-
-CSL files can also be specified in metadata:
-```markdown
----
-bibliography: refs.bib
-csl: apa.csl
----
-```
-
-## Mode Support
-
-**Unified mode:**
-- All citation syntaxes supported (auto-detected)
-- All bibliography formats supported
-- Citations enabled by default when bibliography is provided
-
-**MultiMarkdown mode:**
-- MultiMarkdown citation syntax (`[#key]`)
-- All bibliography formats supported
-- Citations enabled by default when bibliography is provided
-
-**CommonMark/GFM modes:**
-- Citations disabled (pure CommonMark/GFM)
-
-**Kramdown mode:**
-- Citations disabled (Kramdown uses different citation system)
-
-## Performance
-
-Citations are only processed when a bibliography is actually provided (via settings or metadata). This ensures no performance impact when citations aren't being used.
-
-## Related
-
-- [Syntax](Syntax) - Citation syntax reference
-- [Modes](Modes) - Mode-specific citation support

data/ext/apex_ext/apex_src/documentation/app-transformed/Credits.md

@@ -1,11 +0,0 @@
-# Credits
-
-Apex builds upon the work of several excellent Markdown projects:
-
-- [CommonMark](https://commonmark.org) - Specification and reference implementation for a standardized Markdown syntax
-- [cmark-gfm](https://github.com/github/cmark-gfm) - GitHub's fork of cmark with GitHub Flavored Markdown extensions
-- [Kramdown](https://kramdown.gettalong.org) - A fast and extensible Markdown processor
-- [MultiMarkdown 6](https://fletcher.github.io/MultiMarkdown-6) - An extension of the Markdown syntax
-- [TextIndex](https://mattgemmell.scot/) by Matt Gemmell, a syntax for creating indices
-
-Apex brings together the best features from all of these projects into a unified, high-performance processor.