{"id":13718763,"url":"https://github.com/EPLHREU/emily-symbols","last_synced_at":"2025-05-07T10:33:54.545Z","repository":{"id":44945527,"uuid":"356106350","full_name":"EPLHREU/emily-symbols","owner":"EPLHREU","description":"A Plover python dictionary allowing for consistent symbol input with specification of attachment and capitalisation in one stroke.","archived":false,"fork":false,"pushed_at":"2022-01-17T05:04:23.000Z","size":449,"stargazers_count":109,"open_issues_count":3,"forks_count":19,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-07T05:42:20.806Z","etag":null,"topics":["plover","plover-dictionary"],"latest_commit_sha":null,"homepage":"","language":"Rich Text Format","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EPLHREU.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-09T02:14:54.000Z","updated_at":"2025-03-11T05:43:37.000Z","dependencies_parsed_at":"2022-09-15T11:20:40.421Z","dependency_job_id":null,"html_url":"https://github.com/EPLHREU/emily-symbols","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EPLHREU%2Femily-symbols","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EPLHREU%2Femily-symbols/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EPLHREU%2Femily-symbols/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EPLHREU%2Femily-symbols/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EPLHREU","download_url":"https://codeload.github.com/EPLHREU/emily-symbols/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252859986,"owners_count":21815439,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["plover","plover-dictionary"],"created_at":"2024-08-03T01:00:37.263Z","updated_at":"2025-05-07T10:33:54.109Z","avatar_url":"https://github.com/EPLHREU.png","language":"Rich Text Format","funding_links":[],"categories":["Dictionaries"],"sub_categories":["Programming"],"readme":"# Emily's Symbol Dictionary \n\n## Design \n\nThis dictionary was created with the following goals in mind:\n- Have a consistent method to type (pretty much) every symbol \n- Specify spacing and capitalisation of that symbol in 1 stroke \n- Hackable and understandable to anyone who finds it useful :)\n\n## Sections \n\nTo support the design goals, for each symbol there are 6 different options specifiable in sections of each stroke:\n\n1. Unique Starter (Red)\n2. Spacing/Attachment (Orange)\n3. Capitalisation (Teal)\n4. Variant (Green)\n5. Symbol (Purple)\n6. Repetition (Blue)\n\nThese options are mapped to different sections of the steno board:\n\n![Coloured Layout Diagram](img/layout.png)\n\n### Unique Starter\nThe first part of the stroke is always the same and identifies all the symbols.\nIn the Magnum Steno dictionary that I use, `SKHW` is a unique key combination for the left hand that is never used.\n(note that `SKWHR` is used, but by not using `R-`, this makes it unique)\n\n![Unique Starter Diagram](img/starter.png)\n\nDue to this, all the combinations of remaining strokes will have no clashes and are free to be used to specify everything needed. \nTo adjust this starter to your dictionary just change the \"uniqueStarter\" variable at the top of the dictionary!\n\n### Attachment \nThere is a consistent way to specify attachment to the text around a symbol using the `A` and `O` keys.\nFrom community feedback there are two different attachment specification systems that are the inverse of each other:\n- space\n- attachment\n\n`space` specification is the default system.\nWith space attachment, the attachment keys specify on which side of the symbol spaces should be inserted. \nThis means without any attachment keys used, no spaces will be inserted and the symbol will fully attach on both sides like the `/` in: `usr/bin`\nUsing `A` will insert a space before the symbol, and using `O` will insert a space after the symbol.\n\nIn contrast, with `attachment` specification, the attachment keys specify on which side of the symbol spaces should be removed.\nThis means with no attachment specified, spaces are inserted on both side of a symbol, like the `\u0026` in: `one \u0026 two`.\nUsing `A` will remove the space before the symbol, and using `O` will remove the space after the symbol.\n\n`space` may be easier for programming with, due to `/` in file paths and programming language syntax.\nWhereas `attachment` may be easier for writing with, as most symbols in speech are on their own.\nBut try each one and see what works best for you!\n\nTo change which system you want to use, just change the `attachmentMethod` variable at the top of the dictionary between `\"space\"` and `\"attachment\"`.\n\n| Keys | `space` | `attachment` |\n|---------------------------------------------|---------|--------------|\n| ![No Attachment Diagram](img/no-attach.png) | `x.x` | `x . x` |\n\n| Keys | `space` | `attachment` |\n|-------------------------------------------------|---------|--------------|\n| ![Left Attachment Diagram](img/left-attach.png) | `x .x` | `x. x` |\n\n| Keys | `space` | `attachment` |\n|---------------------------------------------------|---------|--------------|\n| ![Right Attachment Diagram](img/right-attach.png) | `x. x` | `x .x` |\n\n| Keys | `space` | `attachment` |\n|-------------------------------------------------|---------|--------------|\n| ![Both Attachment Diagram](img/both-attach.png) | `x . x` | `x.x` |\n\n### Capitalisation \n\nThe `*` can be used to specify capitalisation of the text following the symbol. \n\nBy default no capitalisation is applied.\n| Key | Output |\n|-----------------------------------------|------------------|\n| ![Lowercase Diagram](img/lowercase.png) | `x . x`, `(cons` |\n\nWith the `*` key used, the next input is capitalised.\n| Key | Output |\n|-----------------------------------------|---------------------|\n| ![Uppercase Diagram](img/uppercase.png) | `x . X`, `said \"To` |\n\n### Variant\n\nThere are a lot of similar symbols, to manage this, each symbol has a base symbol and a list of variant symbols. \nThe specific variant required is chosen with a combination of the `E` and `U` keys, this allows for 4 total variants of a symbol.\n\nBy default the base symbol is typed, this is generally the most common of all the variants.\n| Key | Output |\n|-----------------------------------------|----------|\n| ![Variant 0 Diagram](img/variant-0.png) | `(`, `$` |\n\nWhen the `E` key is used, the left (or first) variant is typed instead.\n| Key | Output |\n|-----------------------------------------|----------|\n| ![Variant 1 Diagram](img/variant-1.png) | `[`, `¥` |\n\nWhen the 'U' key is used, the right (or second) variant is typed.\n| Key | Output |\n|-----------------------------------------|----------|\n| ![Variant 2 Diagram](img/variant-2.png) | `\u003c`, `€` |\n\nWhen both `E` and `U` are used, the final variant is typed.\n| Key | Output |\n|-----------------------------------------|----------|\n| ![Variant 3 Diagram](img/variant-3.png) | `{`, `£` |\n\nThese variants are stored in the main symbols dictionary and you should edit them based on which ones are more frequent for you!\nThough I hope my defaults are good enough.\n\n### Symbol \n\nThe main section is the symbol section, used to specify the specific symbol to type.\nOnly a 2x3 grid is needed to address all the symbols, using variants.\nAll of the patterns for symbols are done according to shape, rather than phonetics or briefs, and so should be remember visually with the images as an aid.\nFor each symbol shape the pattern only addresses the base symbol, it doesn't apply as well to the variant symbols. As such, the variants should be anchored in memory to the base symbol itself rather than the pattern. \n\n| Pattern | Symbols | Description |\n|-------------------------------------------------|-------------------------------------------------------|-----------------------------------------------------------------------------|\n| Whitespace | | |\n| ![Whitespace Diagram](img/whitespace.png) | `{#Tab} {#Backspace} {#Delete} {#Escape}` | The pattern aligns with the tips of the arrows on a tab key legend: ↹ |\n| Arrows | | |\n| ![Arrow Diagram](img/arrow.png) | `{#Up} {#Left} {#Right} {#Down}` | Looks like an arrow key cluster |\n| ↑ | | |\n| ![Arrow Symbols Diagram](img/arrow-symbols.png) | `↑ ← → ↓` | Looks like an upside-down arrow key cluster |\n| Navigation | | |\n| ![Navigation Diagram](img/nav.png) | `{#Page_Up} {#Home} {#End} {#Page_Down}` | Arrow key cluster but with an addition key held down |\n| Music | | |\n| ![Music Diagram](img/music.png) | `{#AudioPlay} {#AudioPrev} {#AudioNext} {#AudioMute}` | Like a strangely rotated L for err... _L_ovely music? |\n| Audio | | |\n| ![Audio Diagram](img/audio.png) | `{#AudioMute} {#AudioLowerVolume} {#AudioRaiseVolume} {#Eject}` | Like a smaller strangely rotated L for err... _l_ovely music control? |\n| Blank | | |\n| ![Blank Diagram](img/blank.png) | `'' {*!} {*?} {#Space}` | It's blank! Self descriptive |\n| Capitalization | | |\n| ![Capitalization Diagram](img/capitalization.png)| `{*-\\|} {*\u003c} {\u003c} {*\u003e}` | Up at the top, separate, it's pointy like capital letters |\n| ! | | |\n| ![Exclamation Diagram](img/exclamation.png) | `! ¬ ↦ ¡` | Vertical shape that's off to the left, like `!` on a regular keyboard |\n| \" | | |\n| ![Double Quote Diagram](img/double-quote.png) | `\" “ ” „` | Two dots up high like its shape, and off to the left like on ISO keyboards |\n| \\# | | |\n| ![Hash Diagram](img/hash.png) | `# © ® ™` | Two vertical bars like in the shape |\n| $ | | |\n| ![Dollar Diagram](img/dollar.png) | `$ ¥ € £` | Makes an `S` shape like a `$` |\n| % | | |\n| ![Percent Diagram](img/percent.png) | `% ‰ ‱ φ` | Same as a `/` but with the two extra keys representing the dots |\n| \u0026 | | |\n| ![Ampersand Diagram](img/ampersand.png) | `\u0026 ∩ ∧ ∈` | Makes a mirror image of the standard 'and' brief (mirrored for ease) |\n| ' | | |\n| ![quote Diagram](img/quote.png) | `' ‘ ’ ‚` | One dot up high, similar to `\"`, on the index for importance |\n| ( | | |\n| ![Open Diagram](img/open.png) | `( [ \u003c {` | Similar to the standard steno brief |\n| ) | | |\n| ![Close Diagram](img/close.png) | `) ] \u003e }` | Similar to the standard steno brief |\n| * | | |\n| ![Star Diagram](img/star.png) | `* ∏ § ×` | single dot shape, off to the right like JIS, up high in the sky |\n| + | | |\n| ![Plus Diagram](img/plus.png) | `+ ∑ ¶ ±` | single dot shape, off to the right like JIS, under the star |\n| , | | |\n| ![Comma Diagram](img/comma.png) | `, ∪ ∨ ∉` | Single dot shape, below like on a keyboard, middle finger as less important |\n| - | | |\n| ![Dash Diagram](img/dash.png) | `- − – —` | Line in shape, up in the top right like a normal keyboard |\n| . | | |\n| ![Dot Diagram](img/dot.png) | `. • · …` | Single dot in shape, below like on a keyboard, index finger as important |\n| / | | |\n| ![Slash Diagram](img/slash.png) | `/ ⇒ ⇔ ÷` | Shape of a `/` |\n| : | | |\n| ![Colon Diagram](img/colon.png) | `: ∋ ∵ ∴` | Vertical shape, off to the right like a normal keyboard |\n| ; | | |\n| ![Semicolon Diagram](img/semicolon.png) | `; ∀ ∃ ∄` | Literally a `,` and `.` at the same time |\n| = | | |\n| ![Equals Diagram](img/equals.png) | `= ≡ ≈ ≠` | Literally a `-` and a `_` at the same time |\n| ? | | |\n| ![Question Diagram](img/question.png) | `? ¿ ∝ ‽` | Looks like the top of a `?` |\n| @ | | |\n| ![At Diagram](img/at.png) | `@ ⊕ ⊗ ∅` | Large complicated shape, only way to make a big spiral |\n| \\\\ | | |\n| ![Backslash Diagram](img/backslash.png) | `\\ Δ √ ∞` | Shape of a `\\` |\n| ^ | | |\n| ![Caret Diagram](img/caret.png) | `^ « » °` | Shape of a `^` and other pointy/raised symbols |\n| \\_ | | |\n| ![Underscore Diagram](img/underscore.png) | `_ ≤ ≥ µ` | A line down low opposing `-`, and other lowered symbols |\n| \\` | | |\n| ![Backtick Diagram](img/backtick.png) | `` ` ⊂ ⊃ π`` | Single dot up high, next to `'` |\n| \\| | | |\n| ![Pipe Diagram](img/pipe.png) | `\\| ⊤ ⊥ ¦` | Nice symetrical vertical shape goes in the middle |\n| \\~ | | |\n| ![Tilde Diagram](img/tilde.png) | `~ ⊆ ⊇ ˜` | Makes the shape of a `~` |\n\n### Repetition \n\nYou may want to duplicate certain symbols, such as logical OR `||` or org-mode headings `### Title`.\nRepetition is done with the `-T` and `-S` keys.\n\nBy default any symbol is typed out once.\n| Key | Output |\n|-----------------------------|--------|\n| ![One Diagram](img/one.png) | `:` |\n\nWhen using the `-S` key, the symbol is typed twice in a row. \nThink of 's' pluralising words.\n| Key | Output |\n|-----------------------------|--------|\n| ![Two Diagram](img/two.png) | `::` |\n\nWhen using the `-T` key, the symbol is typed out three times in a row.\nThink _T_riple. \n| Key | Output |\n|---------------------------------|--------|\n| ![Three Diagram](img/three.png) | `:::` |\n\nWhen using both `-S` and `-T` the symbol is typed out a combined 4 times.\n| Key | Output |\n|-------------------------------|--------|\n| ![Four Diagram](img/four.png) | `::::` |\n\n## Poster\n\nCheck out the summary poster made by @sammdot for a nice one-page overview of how the whole dictionary works!\n[emily-symbols-poster](emily-symbols-poster.pdf)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEPLHREU%2Femily-symbols","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FEPLHREU%2Femily-symbols","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FEPLHREU%2Femily-symbols/lists"}