https://github.com/qubist/ticha-atom-snippets
Atom snippets to help with TEI encoding for the Ticha Project
https://github.com/qubist/ticha-atom-snippets
tei ticha
Last synced: 8 months ago
JSON representation
Atom snippets to help with TEI encoding for the Ticha Project
- Host: GitHub
- URL: https://github.com/qubist/ticha-atom-snippets
- Owner: qubist
- License: mit
- Created: 2021-06-09T18:04:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-15T19:01:13.000Z (over 4 years ago)
- Last Synced: 2025-02-15T09:12:51.042Z (8 months ago)
- Topics: tei, ticha
- Homepage: https://atom.io/packages/ticha-atom-snippets
- Size: 1.03 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ticha-atom-snippets
[](https://github.com/RichardLitt/standard-readme)
Atom snippets to help with TEI encoding for the [Ticha Project](https://ticha.haverford.edu/en/)
## Background
[Atom's snippets feature](https://flight-manual.atom.io/using-atom/sections/snippets/) allows us to type a short keyword and press tab to expand it into a larger piece of text. This is useful for repetitive tasks like adding long XML tags. Snippets also let us press tab to "fill out" parts of the expanded text kinda like filling out a form.
## Install
### From inside Atom
1. Use the [Atom UI](https://flight-manual.atom.io/using-atom/sections/atom-packages/#atom-packages) to search for and install the package.
2. Restart Atom.
### From the command line
You can also use Atom's command-line package manager, `apm`:
```
apm install ticha-atom-snippets
```
## Usage
Type a snippet's "prefix" (or enough of it that a tooltip comes up showing the green arrow icon) and press tab. The template text will appear and your cursor will change to be selecting some placeholder text in the template. Start typing to replace this text. Then press tab to move to the next area of the template. Repeat until everything looks right. Once you've filled out all areas of the template, pressing tab will jump your cursor to the end of the template.
### Available snippets
| Snippet | Prefix | Template |
|--------------|-----------|-------------------------------------------------------------------------------------------------|
| Spelling | `orig` | <choice><orig>**originalWord**</orig><reg type="**spanish**">**regularizedWord**</reg></choice> |
| Abbreviation | `abbr` | <choice><abbr>**abbreviation**</abbr><expan>**expansion**</expan></choice> |
| Foreign | `foreign` | <foreign xml:lang="**zap**">**foreignWord**</foreign> |
Bold sections of text in the Template column are sections of the snippet accessible by pressing tab.
### Usage example
Explanation of symbols in the gif:
| Symbol | Key |
|--------|---------|
| ⎋ | Escape |
| ⇥ | Tab |
| ⌘ | Command |
| ⇧ | Shift |
## Contributing
PRs accepted. Also, if you're on the Ticha team and you want me to add a new snippet, let's talk!
## Maintainers
* [Will Harris-Braun](https://github.com/qubist)
# License
[MIT](./LICENSE)