Windows: product names, the editors, WSL; the Linux page's image step
Assembled from development commit c3c40f6c8fca. Since 830b193: on Windows the
products carry Windows names (ktext.exe, klammertext.dll, document.dll,
reflect.dll) and the console's output code page is UTF-8 for a run; the
editor tooling works on Windows (VS Code, Sublime Text, Vim, with the
interpreter's name chosen by platform) and Notepad++ joins it
(doc/edit/notepadpp: a User Defined Language and two Run-menu commands);
a sixth install page, doc/install/windows_wsl_install.md, for Linux
inside WSL; the Windows page opens with the three routes and gains its
editor section, the PowerShell quoting and Path notes; the Linux page
installs OpenImageIO from the python3-openimageio package and verifies
with kdiag --machine; the README lists all six install pages. Linux and
macOS behaviour is unchanged.
This commit is contained in:
ack committed
1 parent
830b19394d
commit
ee8bcf5300
33 files changed
+741
-122
No files matched your search
@@ -0,0 +1,114 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
Klammertext.udl.xml - Notepad++ User Defined Language for Klammertext
|
||||
(.kt documents and .k klammer definitions). Highlighting only: Notepad++
|
||||
has no Python plugin host and no built-in language-server client, so the
|
||||
structural tools of the shared core (doc/edit/shared/klammertext_edit.py)
|
||||
are reached through Run-menu commands instead; README.md has them.
|
||||
|
||||
What it colours, and how (a UDL is a fixed set of token classes, not a
|
||||
grammar; the choices below are the closest fit):
|
||||
|
||||
@@@name, @@@ system commands Keywords1, prefix match, orange
|
||||
@@name, @@ klammer definitions Keywords2, prefix match, green
|
||||
@name, @ klammer applications Keywords3, prefix match, blue
|
||||
The groups are checked in order, longest run first,
|
||||
so @@name is not taken for an @ followed by a name.
|
||||
A named close (name@) is coloured only at its @.
|
||||
^X ^UUUU^ ^' escapes Keywords4, prefix match, the
|
||||
default colour: consumed so the character after the
|
||||
caret is never read as a delimiter, shown as text
|
||||
(as the Emacs mode does).
|
||||
# ... removal to end of line line comment, grey; only
|
||||
when the # is the first thing on its line
|
||||
(forcePureLC), because a UDL comment cannot tell
|
||||
"# comment" from the whitespace operators #- #+ #/,
|
||||
which would otherwise grey the rest of their line.
|
||||
#[ ... ]# removal of a region block comment, grey, folds.
|
||||
## #- #+ #/ the other # forms Operators2, marker red.
|
||||
| : bars and option marks Operators1, marker red.
|
||||
@code ... code@ verbatim interior Delimiters1, muted, nothing
|
||||
inside it is coloured. The other literal klammer,
|
||||
@c ... c@, is NOT here: a UDL delimiter has no word
|
||||
boundary, so "@c" would also open at @caption,
|
||||
@cond and every other c-klammer.
|
||||
|
||||
SYNC: the literal-klammer set's source of truth is LITERAL_KLAMMERS in
|
||||
doc/edit/shared/klammertext_edit.py. When a klammer is added there, add
|
||||
"@NAME" / "NAME@" as a further delimiter pair here (pairs 2 to 8 are free:
|
||||
items 03/05, 06/08, ... in the "Delimiters" list) - if its name is not a
|
||||
prefix of other klammer names.
|
||||
|
||||
Colours are the palette's light-ground values (notes/klammertext_palette.md:
|
||||
application 528599, definition 758B55, system 996743, markers 994040,
|
||||
removed text 9A9A9A); colorStyle="1" keeps every background transparent, so
|
||||
a dark Notepad++ theme keeps its own ground (the hues still read there).
|
||||
|
||||
Install: copy this file into %AppData%\Notepad++\userDefineLangs\ and
|
||||
restart Notepad++ (or Language > User Defined Language > Define your
|
||||
language... > Import...). README.md has the details and the Run commands.
|
||||
-->
|
||||
<NotepadPlus>
|
||||
<UserLang name="Klammertext" ext="kt k" udlVersion="2.1">
|
||||
<Settings>
|
||||
<Global caseIgnored="no" allowFoldOfComments="yes" foldCompact="no" forcePureLC="1" decimalSeparator="0" />
|
||||
<Prefix Keywords1="yes" Keywords2="yes" Keywords3="yes" Keywords4="yes" Keywords5="no" Keywords6="no" Keywords7="no" Keywords8="no" />
|
||||
</Settings>
|
||||
<KeywordLists>
|
||||
<Keywords name="Comments">00# 01 02 03#[ 04]#</Keywords>
|
||||
<Keywords name="Numbers, prefix1"></Keywords>
|
||||
<Keywords name="Numbers, prefix2"></Keywords>
|
||||
<Keywords name="Numbers, extras1"></Keywords>
|
||||
<Keywords name="Numbers, extras2"></Keywords>
|
||||
<Keywords name="Numbers, suffix1"></Keywords>
|
||||
<Keywords name="Numbers, suffix2"></Keywords>
|
||||
<Keywords name="Numbers, range"></Keywords>
|
||||
<Keywords name="Operators1">| :</Keywords>
|
||||
<Keywords name="Operators2">## #- #+ #/</Keywords>
|
||||
<Keywords name="Folders in code1, open"></Keywords>
|
||||
<Keywords name="Folders in code1, middle"></Keywords>
|
||||
<Keywords name="Folders in code1, close"></Keywords>
|
||||
<Keywords name="Folders in code2, open"></Keywords>
|
||||
<Keywords name="Folders in code2, middle"></Keywords>
|
||||
<Keywords name="Folders in code2, close"></Keywords>
|
||||
<Keywords name="Folders in comment, open">#[</Keywords>
|
||||
<Keywords name="Folders in comment, middle"></Keywords>
|
||||
<Keywords name="Folders in comment, close">]#</Keywords>
|
||||
<Keywords name="Keywords1">@@@</Keywords>
|
||||
<Keywords name="Keywords2">@@</Keywords>
|
||||
<Keywords name="Keywords3">@</Keywords>
|
||||
<Keywords name="Keywords4">^</Keywords>
|
||||
<Keywords name="Keywords5"></Keywords>
|
||||
<Keywords name="Keywords6"></Keywords>
|
||||
<Keywords name="Keywords7"></Keywords>
|
||||
<Keywords name="Keywords8"></Keywords>
|
||||
<Keywords name="Delimiters">00@code 01 02code@ 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23</Keywords>
|
||||
</KeywordLists>
|
||||
<Styles>
|
||||
<WordsStyle name="DEFAULT" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="COMMENTS" fgColor="9A9A9A" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="LINE COMMENTS" fgColor="9A9A9A" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="NUMBERS" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="KEYWORDS1" fgColor="996743" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="1" nesting="0" />
|
||||
<WordsStyle name="KEYWORDS2" fgColor="758B55" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="1" nesting="0" />
|
||||
<WordsStyle name="KEYWORDS3" fgColor="528599" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="1" nesting="0" />
|
||||
<WordsStyle name="KEYWORDS4" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="KEYWORDS5" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="KEYWORDS6" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="KEYWORDS7" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="KEYWORDS8" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="OPERATORS" fgColor="994040" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="FOLDER IN CODE1" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="FOLDER IN CODE2" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="FOLDER IN COMMENT" fgColor="994040" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="DELIMITERS1" fgColor="5A5A5A" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="DELIMITERS2" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="DELIMITERS3" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="DELIMITERS4" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="DELIMITERS5" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="DELIMITERS6" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="DELIMITERS7" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
<WordsStyle name="DELIMITERS8" fgColor="000000" bgColor="FFFFFF" colorStyle="1" fontName="" fontStyle="0" nesting="0" />
|
||||
</Styles>
|
||||
</UserLang>
|
||||
</NotepadPlus>
|
||||
@@ -0,0 +1,114 @@
|
||||
# Klammertext support for Notepad++
|
||||
|
||||
Notepad++ support for editing Klammertext files (`.kt` documents and `.k`
|
||||
klammer definitions): syntax highlighting through a **User Defined
|
||||
Language**, and the shared editor core's delimiter check and
|
||||
reindentation through two **Run-menu commands**. Notepad++ is Windows
|
||||
only, and so is this package.
|
||||
|
||||
Notepad++ has no Python plugin host and no built-in language-server
|
||||
client, so it cannot import the shared core the way Sublime Text does or
|
||||
talk to the language server the way VS Code does. What it has is a
|
||||
declarative highlighter and a Run menu that can invoke any program on the
|
||||
current file, and this package uses exactly those two things.
|
||||
|
||||
## Files
|
||||
|
||||
| File | Purpose |
|
||||
|---|---|
|
||||
| `Klammertext.udl.xml` | The User Defined Language: highlighting for the three `@`-tiers, escapes, text removal, and the `@code` verbatim interior. Its header lists what it colours and the limits of a UDL. |
|
||||
| `klammertext_edit.py` | The shared editor core (in the editing zip it sits here; in the Klammertext repository it is `doc\edit\shared\klammertext_edit.py`). The Run commands call it. |
|
||||
| `README.md` | This file. |
|
||||
|
||||
## Requirements
|
||||
|
||||
- Notepad++ 7.9 or later (the `userDefineLangs` folder; any recent
|
||||
version qualifies).
|
||||
- For the Run commands: `python` on the `Path`, which the Klammertext
|
||||
installation already needs.
|
||||
|
||||
## Install the highlighting
|
||||
|
||||
Copy `Klammertext.udl.xml` into Notepad++'s user-defined-language folder
|
||||
and restart Notepad++:
|
||||
|
||||
```powershell
|
||||
$d = "$env:AppData\Notepad++\userDefineLangs"
|
||||
New-Item -ItemType Directory -Force $d | Out-Null
|
||||
Copy-Item Klammertext.udl.xml $d
|
||||
```
|
||||
|
||||
Notepad++ loads every file in that folder at start. `.kt` and `.k` files
|
||||
then open as "Klammertext" (the language shows in the status bar and at
|
||||
the bottom of the **Language** menu). The alternative is the dialog:
|
||||
**Language ￫ User Defined Language ￫ Define your language… ￫ Import…**,
|
||||
which copies the file to the same place.
|
||||
|
||||
What you see: klammer applications (`@name … @`) in blue, definitions
|
||||
(`@@name … @@`) in green, system commands (`@@@name … @@@`) in orange;
|
||||
a `#` at the start of a line greys the rest of the line, `#[ … ]#` greys
|
||||
and folds a region; `##`, `#-`, `#+`, `#/`, `|` and `:` in the marker
|
||||
red; the interior of `@code … code@` muted and uninterpreted. The
|
||||
colours are the palette's light-ground values with transparent
|
||||
backgrounds, so a dark theme keeps its own ground.
|
||||
|
||||
Two limits, both properties of a UDL rather than of Klammertext, are
|
||||
documented in the file's header: a `#` that is not the first thing on
|
||||
its line is not treated as a comment (so that the whitespace operators
|
||||
`#-`, `#+`, `#/` never grey the rest of their line), and `@c … c@` is not
|
||||
made verbatim (a UDL delimiter has no word boundary, so `@c` would also
|
||||
open at `@caption` and `@cond`).
|
||||
|
||||
## The Run commands
|
||||
|
||||
The shared core's command-line interface reads a file on standard input
|
||||
and writes the result on standard output; Notepad++'s **Run ￫ Run…**
|
||||
dialog (`F5`) runs a command line with the current file's path filled in
|
||||
as `$(FULL_CURRENT_PATH)`. Two commands cover the structural tools.
|
||||
Replace `C:\Users\<you>\klammertext\doc\edit\shared` with the folder that
|
||||
holds `klammertext_edit.py` (with the editing zip, the folder this
|
||||
README is in).
|
||||
|
||||
**Check the delimiters** — lists every unclosed opening, extra close,
|
||||
name or tier mismatch, and unclosed literal span or `#[` block, as
|
||||
`line:column: message`; an empty window means the file is balanced.
|
||||
The `/k` keeps the window open to read:
|
||||
|
||||
```
|
||||
cmd /k python "C:\Users\<you>\klammertext\doc\edit\shared\klammertext_edit.py" check < "$(FULL_CURRENT_PATH)"
|
||||
```
|
||||
|
||||
**Reindent the file** — rewrites the file with the canonical
|
||||
indentation (2 spaces per nesting level, bars and closes at their
|
||||
opener's column, `@document` transparent, verbatim and removed text
|
||||
untouched):
|
||||
|
||||
```
|
||||
cmd /c python "C:\Users\<you>\klammertext\doc\edit\shared\klammertext_edit.py" indent < "$(FULL_CURRENT_PATH)" > "$(FULL_CURRENT_PATH).tmp" && move /y "$(FULL_CURRENT_PATH).tmp" "$(FULL_CURRENT_PATH)"
|
||||
```
|
||||
|
||||
Paste each line into the Run dialog once, press **Save…**, give it a
|
||||
name ("Klammertext check", "Klammertext reindent") and a shortcut
|
||||
(`Ctrl+Alt+K`, `Ctrl+Alt+I` are free); they then appear at the bottom of
|
||||
the **Run** menu with those keys.
|
||||
|
||||
Two things to know about the reindent command. It works on the file
|
||||
**on disk**, so save first (`Ctrl+S`); Notepad++ does not save before
|
||||
running. And after it runs, Notepad++ notices the changed file: with the
|
||||
default setting it asks whether to reload, which you answer Yes; under
|
||||
**Settings ￫ Preferences ￫ MISC. ￫ File Status Auto-Detection** the
|
||||
choice "Update silently" makes the reload automatic. Undo history is
|
||||
lost on a reload, as for any external edit.
|
||||
|
||||
Table alignment and jump-to-match need a caret position the Run dialog
|
||||
cannot pass, so they are not offered here. They are available in every
|
||||
other supported editor, and for Notepad++ through the PythonScript
|
||||
plugin, which embeds a Python that can import the shared core and reach
|
||||
the caret; a script for it is a possible addition, not part of this
|
||||
package.
|
||||
|
||||
## Keeping things in sync
|
||||
|
||||
The UDL restates the literal-klammer set (`@code`) that the shared core
|
||||
owns in `LITERAL_KLAMMERS`; its header says how to add one. The editor
|
||||
support's overview is `doc/edit/README.md` in the Klammertext repository.
|
||||
Reference in new issue
Block a user