hyperlist 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 134e2668f610e62a6235ba3ca1a629237321a62b175454cf7b26d1f365e2a2e5
+  data.tar.gz: 1c82ce134d1ce3a91ced0cd0e041c7285721530cd7bd7c802d59b3a850b9a1d2
+SHA512:
+  metadata.gz: 60af0235c69750163718233ced6d74436fa3fbf5716ca2cfcc38f8c80bea242193131fe266b1aebaf47c9c95b517df881b0da443cc0a8f7d93c7af74f85cafa7
+  data.tar.gz: dd9f54b1f74513e947f5d9b89a72ff2abe1ccab6af3d4f1c5b607b6e366806b6fd4aca7b3c612b8f469d0bd57c023f1a7b53769f0befa8453575b46f70d84042

data/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Changelog
+
+All notable changes to the HyperList Ruby TUI will be documented in this file.
+
+## [1.0.0] - 2025-08-12
+
+### Initial Release
+
+#### Features
+- Full HyperList syntax support with color highlighting
+- Hierarchical list management with unlimited nesting
+- Advanced folding system with multi-level support
+- Powerful navigation including marks, jumps, and references
+- Complete editing capabilities (insert, delete, move, copy, paste)
+- Multiple checkbox types with completion tracking
+- Template system with marker navigation
+- Presentation mode for focused viewing
+- Search functionality with highlighting
+- Undo/redo support with repeat last action
+- Split view for working with multiple lists
+- Autosave functionality with configurable intervals
+- Recent files list
+
+#### Export Formats
+- HTML with full syntax highlighting and responsive design
+- Markdown (GitHub-flavored)
+- Plain text
+- PNG graph visualization (requires Graphviz)
+
+#### Text Formatting
+- Bold (*text*)
+- Italic (/text/)
+- Underline (_text_)
+- References (<reference>)
+- Hash tags (#tag)
+- Comments (; comment)
+- Date/time support
+
+#### Keyboard Shortcuts
+- Comprehensive vim-like key bindings
+- Help system with full documentation
+- Customizable through command mode
+
+#### File Support
+- Native .hl HyperList files
+- Any text file can be edited as HyperList
+- UTF-8 support with unicode and emoji
+
+### Technical
+- Built with Ruby 3.0+
+- Uses rcurses for terminal UI
+- Public Domain license

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

data/README.md

@@ -0,0 +1,216 @@
+# HyperList Ruby TUI
+
+A powerful Terminal User Interface (TUI) application for creating, editing, and managing HyperLists - a methodology for describing anything in a hierarchical, structured format.
+
+## What is HyperList?
+
+HyperList is a universal methodology for describing anything - any state, item, pattern, action, process, transition, program, instruction set, etc. It can be used as an outliner, a todo list handler, a process design tool, a data modeler, or any other way you want to describe something.
+
+Learn more about the HyperList methodology at: [https://isene.org/hyperlist/](https://isene.org/hyperlist/)
+
+For historical context and the original VIM implementation, see: [hyperlist.vim](https://github.com/isene/hyperlist.vim)
+
+## Features
+
+### Core Functionality
+- **Hierarchical Organization**: Create multi-level nested lists with unlimited depth
+- **Rich Syntax Highlighting**: Color-coded elements for better readability
+  - Properties and dates in red
+  - Operators (AND, OR, IF, THEN) in blue
+  - Checkboxes in various shades of green
+  - References in magenta
+  - Hash tags in yellow/orange
+  - Comments in cyan
+- **Advanced Folding**: Collapse and expand sections with multiple fold levels
+- **Powerful Navigation**: Jump between items, references, and markers
+- **Full Editing Capabilities**: Create, edit, delete, move, and reorganize items
+- **Checkbox Support**: Multiple checkbox types with completion tracking
+- **Template System**: Jump to and fill in template markers
+- **Presentation Mode**: Focus on current item and ancestors only
+
+### Text Formatting
+- **Bold**: `*text*`
+- **Italic**: `/text/`
+- **Underline**: `_text_`
+- **References**: `<reference name>` or `<file:/path/to/file>`
+- **Hash tags**: `#tag`
+- **Comments**: `; comment text`
+- **Dates**: `2025-08-12` or `2025-08-12 14:30`
+
+### Export Formats
+- **HTML**: Full-featured HTML with syntax highlighting
+- **Markdown**: GitHub-flavored Markdown
+- **Plain Text**: Clean text output
+- **PNG Graph**: Visual representation using Graphviz
+
+### File Operations
+- Multiple file support with recent files list
+- Autosave functionality with configurable intervals
+- Split view for working with multiple lists
+
+## Installation
+
+### Prerequisites
+- Ruby 3.0 or higher
+- rcurses gem: `gem install rcurses`
+- Optional: Graphviz for PNG export (`apt-get install graphviz` or `brew install graphviz`)
+
+### Install from RubyGems
+```bash
+gem install hyperlist
+```
+
+### Install from Source
+```bash
+git clone https://github.com/isene/HyperList.git
+cd HyperList
+chmod +x hyperlist
+./hyperlist
+```
+
+## Usage
+
+### Basic Usage
+```bash
+hyperlist                    # Start with empty document
+hyperlist file.hl           # Open existing HyperList file
+hyperlist file.txt          # Open any text file
+```
+
+### Key Bindings
+
+#### Navigation
+- `j/↓` - Move down
+- `k/↑` - Move up
+- `h` - Go to parent item
+- `l` - Go to first child
+- `g/Home` - Go to top
+- `G/End` - Go to bottom
+- `/` - Search
+- `n` - Next search match
+- `N` - Next template marker (=)
+
+#### Editing
+- `i/Enter` - Edit line
+- `o` - Insert line below
+- `O` - Insert line above
+- `a` - Insert child item
+- `D` - Delete and yank line
+- `C-D` - Delete and yank item with descendants
+- `y/Y` - Copy line/tree
+- `p` - Paste
+
+#### Folding
+- `Space` - Toggle fold
+- `za` - Toggle all folds
+- `1-9` - Expand to level
+- `0` - Multi-digit fold level
+
+#### Features
+- `v` - Toggle checkbox
+- `V` - Toggle checkbox with timestamp
+- `R` - Go to reference
+- `F` - Open file reference
+- `P` - Presentation mode
+- `?` - Help screen
+
+#### File Commands
+- `:w` - Save
+- `:q` - Quit
+- `:wq` - Save and quit
+- `:e file` - Open file
+- `:export html` - Export to HTML
+- `:export md` - Export to Markdown
+- `:graph` - Export to PNG
+
+## Examples
+
+### Simple Todo List
+```
+Daily Tasks
+    [ ] Morning review
+        [ ] Check emails
+        [ ] Review calendar
+    [ ] Development work
+        [ ] Fix bug #123
+        [ ] Code review
+    [X] Lunch break
+    [ ] Afternoon tasks
+```
+
+### Project Structure
+```
+MyProject #project
+    Planning Phase
+        [X] Define objectives
+        [O] Identify stakeholders
+        [ ] Create timeline
+    Implementation
+        Backend Development
+            Authentication module
+            Database schema
+            REST endpoints
+        Frontend Development
+            Login page
+            Dashboard
+    Documentation
+        Technical docs
+        User manual
+```
+
+### Meeting Notes with References
+```
+Team Meeting 2025-08-12 14:00
+    Participants
+        John (PM)
+        Sarah (Dev)
+        Mike (Design)
+    Discussion Points
+        Sprint planning <Sprint-23>
+        Bug review <file:./bugs.hl>
+        Design updates
+            ; Mike will share mockups
+    Action Items
+        [ ] John: Update roadmap
+        [ ] Sarah: Fix critical bugs
+        [ ] Mike: Finalize designs
+```
+
+## Configuration
+
+The application stores configuration in `~/.hyperlist/`:
+- `recent_files.txt` - List of recently opened files
+- `marks.yml` - Saved marks across sessions
+
+## Testing
+
+Run the included test suite:
+```bash
+./hyperlist test.hl
+```
+
+Follow the instructions in the test file to verify all features are working correctly.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit issues and pull requests.
+
+## License
+
+This software is released into the **Public Domain**.
+
+## Author
+
+Created by Geir Isene - [https://isene.org](https://isene.org)
+
+Based on the HyperList methodology and inspired by the original hyperlist.vim plugin.
+
+## Acknowledgments
+
+- The rcurses library for excellent terminal UI capabilities
+- The Ruby community for a wonderful programming language
+- All contributors and users of HyperList
+
+---
+
+For more information about HyperList, visit [https://isene.org/hyperlist/](https://isene.org/hyperlist/)