FAQ - SciTE Editor

Dieser Thread soll als FAQ für SciTE genutzt werden.

Aus den gestellten Fragen und gegebenen Antworten werde ich jeweils einen zusammenfassenden Post bilden und im Startpost verlinken. (Die Frage-Antwort-Posts werde ich der Übersichtlichkeit halber danach entfernen --> verschieben: Link ). Die Entwickler-Threads für SciTE bleiben davon unberührt im Unterforum: Lua.

• Wie funktioniert das Properties Dateisystem von SciTE?
• Welche HotKeys gibt es in SciTE?
• Wie stellt man die SciTE-Oberfläche auf Deutsch ein?
• Wie kann ein Button der SciTE-Toolbar En/Disabled werden?
• Wie kann man die Konsolenausgabe während der Ausführung mitscrollen lassen und nach dem Beenden des Programms das Ende der Konsolenausgabe anzeigen?
• Wie richte ich User-Shortcuts ein?
• Wie richte ich das User-Kontext-Menü ein?
• Wie kann man das aktuelle Datum an der Cursor-Position einfügen?
• Wie deaktiviere ich die Fehleranzeige innerhalb des Skriptbereiches (inline error)?
• Wie kann man den Toolbar-Speicher-Button ausgrauen, wenn keine Änderung im Script vorhanden, also nichts zu speichern ist?
• Wie kann ich den Hintergrund beim Ausdruck aus SciTE anpassen?
• SciTE in Mehrbenutzerinstallation ohne Adminrechte
• Wie kann ich eine "Sitzung" (also z.B. meine aktuell bearbeiteten Dateien) mit wenig Aufwand gleichzeitig öffnen? Teil 1 / Teil 2
• Wie kann man in SciTE4AutoIt3 eine weitere Hilfedatei einbinden, z.B. für Lua?
• Wie kann das aktive Tab-Item hervorgehoben werden?

Wie funktioniert das Properties Dateisystem von SciTE?

(Original Dokumentation scintilla)

Es werden bis zu 4 Basis Properties Dateien verwendet in dieser Rangfolge:

1. Local properties (SciTE.properties), überschreiben Einstellungen aus 2. bis 4.

Wird bei Bedarf im selben Verzeichnis erstellt, indem sich die editierte Datei befindet.

Umgebungsvariablen stehen auch als Proprty zur Verfügung und können hier z.B. explizit überschrieben werden.

2. Directory properties (SciTEDirectory.properties), überschreiben Einstellungen aus 3. und 4.

Wird bei Bedarf im selben oder im Elternverzeichnis der editierten Datei erstellt.

Z.B. verwendbar als projektspezifische Einstellungsdatei, da es für alle Unterverzeichnisse wirksam ist.

3. User properties (SciTEUser.properties), überschreiben Einstellungen aus 4.

Bei Standardinstallation in: C:\Users\USER-NAME\AppData\Local\AutoIt v3\SciTE

Hier kommen alle eigenen Änderungen an Aussehen und Verhalten des Editors hinein.

4. Global properties (SciTEGlobal.properties)

Bei Standardinstallation in: C:\Program Files (x86)\AutoIt3\SciTE

Enthält alle Editoreinstellungswerte.

Wenn SciTE intern auf eine Proprty zugreift, geschieht das nach dieser Priorität. D.h., nur wenn kein Eintrag in Local/Directory oder User vorhanden ist wird auf die Standardeinstellung (Global) zugegriffen.

"SciTEGlobal.properties" enthält alle Nicht-sprachspezifischen Properties.

Wenn diese Properties geändert werden sollen:

- Property kopieren

- in "SciTEUser.properties" eintragen

- gewünschten Benutzerwert setzen

Grundsätzlich sollen in der Global keine Änderungen vorgenommen werden, da diese die Standardeinstellungen vorhält.

Sprachbezogene Einstellungen werden sinnvollerweise in eigenen Properties Dateien gespeichert und mit dem Schlüsselwort "import" eingebunden (s. letzter Block in "SciTEGlobal.properties").

Man kann auch ganz individuelle Properties Dateien erstellen, welche in der User Datei ganz am Anfang eingebunden werden. Kann so aussehen:

import ownhotkeys

import python_user

import lua_user

Alle nur AutoIt-relevanten Einstellungen finden wir in der "au3.properties". Das betrifft z.B. die Hotkeys für Run/Compile etc.

Wenn in einer *.au3 der Hotkey "Ctrl+1" aufgerufen wird, wird eine Konfigurationsoberfläche eingeblendet. Diese greift lesend auf die au3.properties zu und ändert die Werte durch Einträge in der SciTEUser.properties.

Auch hier empfielt es sich für Änderungen ausserhalb des Konfig-Tools, die gewünschte Property zu kopieren und in der User Datei den individuellen Wert zuzuweisen.

Um eine in der au3.properties vergebene Kommando-Nr. zu deaktivieren, weist man dieser einen leeren Kommando-Namen zu, z.B.: command.name.10.$(au3)=.

Zum Neu Belegen müssen dann alle Befehlskomponenten angepasst werden ( command.10.$(au3)=, command.mode.10.$(au3)=, command.shortcut.10.$(au3)= )

Welche HotKeys gibt es in SciTE?

Das Thema wurde umfangreiche in diesem Post behandelt.

Wie stellt man die SciTE-Oberfläche auf Deutsch ein?

Dazu einfach die Datei locale.txt aus dem Anhang als locale.properties in das Installationsverzeichnis von SciTE kopieren.

Wie kann man das aktuelle Datum an der Cursor-Position einfügen?

command.name.19.*=Insert Date
command.19.*=dostring editor:AddText(os.date('%d.%m.%Y'))  
command.mode.19.*=subsystem:lua,savebefore:no
command.shortcut.19.*=Shift+Alt+F11

"19" mit einer nicht belegten Kommando-Nr. ersetzen, für "Shift+Alt+F11" setzt ihr den gewünschten HotKey.

Der Vorteil des Properties wird hier sichtbar: Das Subsystem ist "lua" - das bedeutet Lua-Code soll ausgeführt werden. Somit kann ich hier auch komplexe Lua-Skripte direkt einsetzen ohne extra Dateien aufzurufen.

Wo finde ich freie Kommando-Nummern?

Man sucht in der au3.properties nach der letzten belegten Kommandonummer - bei mir ist das z.B. :

# 34 Generate UDF header ...

command.name.34.$(au3)=Make UDF Header
...

(in dieser Datei bitte nichts ändern !)

Die Nummern bis 49 können dann individuell genutzt werden.

Wenn man in der SciTE-Konfiguration einige der AutoIt-Tools abgewählt hat, werden automatisch die frei gewordenen Kommando-Nr. in die SciTEUser.properties übertragen und können auch verwendet werden. Bei mir sieht das z.B. so aus:

command.name.16.*=

command.name.15.*=

command.name.4.$(au3)=

command.name.2.$(au3)=

command.name.1.$(au3)=

command.name.0.$(au3)=

Wie kann ein Button der SciTE-Toolbar En/Disabled werden?

;-- TIME_STAMP   2019-07-05 11:37:50

Opt('MustDeclareVars', 1)

#include <WinAPISys.au3>
#include <GuiToolbar.au3>

#cs
    SciTE: Enablen / Disablen von Buttons der Toolbar
    by BugFix
#ce

; 1. Index des gewünschten Button ermitteln
;     Die Trennstriche zählen mit!
;    Gezählt wird bei 0 beginnend.
;    Bsp. Button "Save": Davor liegt "Trenner", "NEW", "OPEN" --> "SAVE" ist das 4.te Element - somit Index "3"
Local $iIndexSave = 3

; 2. Disablen / Enablen
;    Disable
_ToolbarButton_Enable($iIndexSave, False)

Sleep(3000)
;    Enable
_ToolbarButton_Enable($iIndexSave)


Func _ToolbarButton_Enable($_iIndex, $_bEnable=True)
    Local $hToolbar = _GetSciTEToolbarHwnd()
    Local $iCmd = _GUICtrlToolbar_IndexToCommand($hToolbar, $_iIndex)
    Local $iState = _GUICtrlToolbar_GetButtonState($hToolbar, $iCmd)
    Local $iNewState = $_bEnable ? BitOR($iState, $TBSTATE_ENABLED) : BitXOR($iState, $TBSTATE_ENABLED)
    _GUICtrlToolbar_SetButtonState($hToolbar, $iCmd, $iNewState)
EndFunc


Func _GetSciTEToolbarHwnd()
    Local $hWndSciTE = WinGetHandle('[CLASS:SciTEWindow]')
    If Not IsHWnd($hWndSciTE) Then Return SetError(1,0,0)
    Local $aChilds = _WinAPI_EnumChildWindows($hWndSciTE)
    If IsArray($aChilds) Then
        For $i = 1 To $aChilds[0][0]
            If $aChilds[$i][1] = 'ToolbarWindow32' Then Return $aChilds[$i][0]
        Next
    EndIf
    Return SetError(2,0,0)
EndFunc

Wie deaktiviere ich die Fehleranzeige innerhalb des Skriptbereiches (inline error)?

Beantwortet in diesem Post.

Wie richte ich das User-Kontext-Menü ein?

Für sehr Maus-affine User ist das Kontextmenü unabdingbar, weil man u. A. alle Funktionen, die im Menü Extras liegen, auf dieses Menü umleiten kann.

Speicherung und Syntax sind analog zu den User-Shortcuts (Anzeigename=Kommando).

user.context.menu=\

||\

Next File|IDM_NEXTFILE|\

Prev File|IDM_PREVFILE|

Möchte man auf die Kommandos der au3.properties und SciTEUser.properties zugreifen, verwendet man

als KommandoNummer die "11"

& die Nummer von: command.24.*.au3=.

So kann man z.B. Lua-Befehle auf ein Kommando legen und dieses als Kontextmenü Eintrag verfügbar machen:

command.name.24.*=Delete Current Line

command.mode.24.*=subsystem:lua,savebefore:no

command.24.*=dostring scite.SendEditor(SCI_LINEDELETE)

user.context.menu=\

||\

Delete Current Line|1124|

Wie kann man den Toolbar-Speicher-Button ausgrauen, wenn keine Änderung im Script vorhanden, also nichts zu speichern ist?

Dazu habe ich folgende AutoIt-Lösung erstellt.

EDIT: Modifikationen von Bitnugger übernommen

;-- TIME_STAMP   2019-07-26 09:32:14

; created  by @BugFix
; modified by @Bitnugger

; setzt Status des Toolbar-Button <SAVE> abhängig von Erfordernis zu speichern oder nicht auf ENABLE/DISABLE
; Skript kompilieren
; mit Autostart-Eintrag starten
; läuft ständig im Hintergrund, kann mit '"Skript\Pfad" /Exit' beendet werden


#NoTrayIcon

#include <Misc.au3>
#include <WinAPISys.au3>
#include <GuiToolbar.au3>

Opt('MustDeclareVars', 1)

If Not @Compiled Then Exit 1

Global $g_hUSER32 = DllOpen('user32.dll')

; Index des gewünschten Button ermitteln
; Die Trennstriche zählen mit! Gezählt wird bei 0 beginnend.
; Bsp. Button "Save": Davor liegt "Trenner", "NEW", "OPEN" --> "SAVE" ist das 4.te Element - somit Index "3"
Global Const $g_iIndexSave = 3

If $CMDLINE[0] And $CMDLINE[1] = '/Exit' Then _SciTE_EnDisable_SaveBtn_Exit()

_Singleton('SciTE_EnDisable_SaveBtn') ; Enforce a design paradigm where only one instance of the script may be running


While Sleep(500)
    _CheckAndSetState()
WEnd
Exit



Func _CheckAndSetState()
    Local $hScite, $sTitle, $iBtnState, $iNewState, $hWndToolbar, $idCmd, $aResult

    $hScite = WinGetHandle('[ACTIVE]')
    $aResult = DllCall($g_hUSER32, "int", "GetClassNameW", "hwnd", $hScite, "wstr", "", "int", 4096)
    If Not @error And $aResult[2] = 'SciTEWindow' Then
        $hWndToolbar = ControlGetHandle($hScite, '', '[CLASS:ToolbarWindow32; INSTANCE:1]')
        $aResult = DllCall($g_hUSER32, "bool", "IsWindowVisible", "hwnd", $hWndToolbar)
        If Not @error And $aResult[0] Then
            $idCmd = _GUICtrlToolbar_IndexToCommand($hWndToolbar, $g_iIndexSave)
            $sTitle = WinGetTitle($hScite)
            If StringRegExp($sTitle, 'SciTE( \[\d+ (of|von) \d+\])?$') Then
                $iBtnState = _GUICtrlToolbar_GetButtonState($hWndToolbar, $idCmd)
                If Not StringInStr($sTitle, '*') And BitAND($iBtnState, $TBSTATE_ENABLED) Then
                    $iNewState = BitXOR($iBtnState, $TBSTATE_ENABLED)
                ElseIf StringInStr($sTitle, '*') And Not BitAND($iBtnState, $TBSTATE_ENABLED) Then
                    $iNewState = BitOR($iBtnState, $TBSTATE_ENABLED)
                Else
                    Return
                EndIf
                _GUICtrlToolbar_SetButtonState($hWndToolbar, $idCmd, $iNewState)
            EndIf
        EndIf
    EndIf
EndFunc

Func _SciTE_EnDisable_SaveBtn_Exit()
    Local $aWinList = WinList('[CLASS:SciTEWindow]'), $hWndToolbar, $idCmd, $iBtnState, $iNewState, $aProcessList = ProcessList(@ScriptName)
    For $i = 1 To $aProcessList[0][0] Step 1
        If $aProcessList[$i][1] <> @AutoItPID Then ProcessClose($aProcessList[$i][1])
    Next
    For $i = 1 To $aWinList[0][0] Step 1
        $hWndToolbar = ControlGetHandle($aWinList[$i][1], '', '[CLASS:ToolbarWindow32; INSTANCE:1]')
        $idCmd = _GUICtrlToolbar_IndexToCommand($hWndToolbar, $g_iIndexSave)
        $iBtnState = _GUICtrlToolbar_GetButtonState($hWndToolbar, $idCmd)
        $iNewState = BitOR($iBtnState, $TBSTATE_ENABLED)
        If $iNewState <> $iBtnState Then _GUICtrlToolbar_SetButtonState($hWndToolbar, $idCmd, $iNewState)
    Next
    DllClose($g_hUSER32)
    Exit
EndFunc

Die kompilierte Exe über den Autostart laden ist der einfachste Weg. Dann dümpelt das Skript ständig im Hintergrund und tut seine Arbeit, kann aber bei Bedarf auch mit dem Parameter /Exit beendet werden.

Wie kann ich den Hintergrund beim Ausdruck aus SciTE anpassen?

Das wird geregelt mit print.colour.mode

Einfügen in die SciTEUser.properties mit dem gewünschten Modus:

Zitat von Hilfe zu SciTE

Einige Leute bevorzugen hellen Text auf einem schwarzen Hintergrund auf dem Bildschirm, aber dunklen Text auf Weiß auf Papier. Wenn print.colour.mode auf 1 gesetzt ist, wird jede Farbe zum Drucken invertiert. Bei der Einstellung 2 wird beim Drucken schwarzer Text auf weißem Hintergrund ausgegeben. 3 setzt den Hintergrund auf Weiß und 4 setzt den Standardhintergrund auf Weiß.

SciTE in Mehrbenutzerinstallation ohne Adminrechte

SciTE/AutoIt wurde von Admin (oder anderem User mit Adminrechten) installiert. Selbst hat man keine Adminrechte. Somit ist keine normale Funktionalität gewährleistet.

Lösung:

C:\Users\InstallationsUser\AppData\Local\AutoIt v3\SciTE

nach

C:\Users\NormalerUser\AppData\Local\AutoIt v3\SciTE

kopieren und

Umgebungsvariable SCITE_USERHOME

auf dieses Verzeichnis setzen.

Wie kann man in SciTE4AutoIt3 eine weitere Hilfedatei einbinden, z.B. für Lua?

Zitat von Professor Bernd

Wie kann man in SciTE4AutoIt3 eine weitere Hilfedatei einbinden, z.B. für Lua?

Ich habe lokal abgespeichert: C:/CODE/Lua/doc/lua/www.lua.org/manual/5.1/manual.html

Das Verzeichnis "doc" habe ich angehängt, dann brauchst du nur den Rest des Pfades (und den Pfad deines Browsers) anpassen.

Wenn du keine shell.exec verwendest, musst du dort: os.execute verwenden. Oder mit Default-Browser: os.execute('start "" "'..manual..sel..'"')

(dann gibts das Aufpoppen des Cmd-Windows)

Der Aufruf einer Hilfedatei ist immer an das hinterlegte Filepattern gebunden (au3->AutoIt, lua->Lua, etc.)

In den "SciTEUser.properties" dann einfügen:

command.help.$(file.patterns.lua)=dostring \
local chrome = "C:/Program Files (x86)/Google/Chrome/Application/chrome.exe" \
local manual = "file:///C:/CODE/Lua/doc/lua/www.lua.org/manual/5.1/manual.html#pdf-" \
local sel = props["CurrentSelection"] \
if sel == "" then manual = "file:///C:/CODE/Lua/doc/lua/www.lua.org/manual/5.1/manual.html" end \
shell.exec('"'..chrome..'" "'..manual..sel..'"')
command.help.subsystem.$(file.patterns.lua)=3

Wenn du jetzt einen Begriff in einem lua-Skript markierst und F1 drückst, wird das Manual mit dem Begriff geöffnet (sofern dafür eine Beschreibung hinterlegt ist). Ohne Markierung wird das Manual am Beginn geöffnet.

UPDATE

Die Version 5.1 ist ja obsolet. Ich habe mal die 5.3 noch angefügt.

Für den Aufruf dann "lua5.3.zip" entpacken und mit "file:///Lw:/DEIN/PFAD/lua5.3/manual.html" darauf verweisen:

command.help.$(file.patterns.lua)=dostring \
local chrome = "C:/Program Files (x86)/Google/Chrome/Application/chrome.exe" \
local manual = "file:///C:/CODE/Lua/doc/lua5.3/manual.html#pdf-" \
local sel = props["CurrentSelection"] \
if sel == "" then manual = "file:///C:/CODE/Lua/doc/lua5.3/manual.html" end \
shell.exec('"'..chrome..'" "'..manual..sel..'"')
command.help.subsystem.$(file.patterns.lua)=3

EDIT

Bei Verwendung von Hilfedateien (*.chm) würde der Aufruf so erfolgen (Bsp. Python):

command.help.$(file.patterns.py)=$(CurrentWord)!C:\Python27\Doc\python274.chm
command.help.subsystem.$(file.patterns.py)=4

Sicher auch sinnvoll: Lua-Skripte mit F5 ausführen

(ebenfalls in "SciTEUser.properties" eintragen)

command.go.$(file.patterns.lua)=dofile $(FilePath)
command.go.subsystem.$(file.patterns.lua)=3

EDIT:

Syntaxcheck ist auch brauchbar

Dazu habe ich eine Funktion geschrieben, die so in "SciTEUser.properties" eingebunden wird:

# 22 Syntax Check Lua, if error --> selects error line and makes it visible
command.name.22.$(file.patterns.lua)=SyntaxCheck Lua
command.22.$(file.patterns.lua)=dofile $(Lua.User.Scripts.Path)/LuaCheck.lua
command.mode.22.$(file.patterns.lua)=subsystem:lua,savebefore:yes
command.shortcut.22.$(file.patterns.lua)=Ctrl+F5

Lua.User.Scripts.Path ist eine Property, die vorher definiert werden muss, z.B. Lua.User.Scripts.Path=C:\Code\Lua

-- TIME_STAMP   2020-10-03 10:25:18

do
    local time = function() local tD = os.date("*t", os.time()) return string.format('%02d:%02d:%02d',tD.hour,tD.min,tD.sec) end
    print("+ ["..time().."] Syntax-Check <"..props['FilePath']..">") io.flush()
    local status, err = pcall(function() assert(loadfile(props['FilePath'])) end)
    if status then
        print("> ["..time().."] ------> OK") io.flush()
    else
        local filename = (props['FileNameExt']):gsub('([%(%)%.%%%+%-%*%?%[%^%$])', '%%%1') -- escape magic characters
        local line, errout = err:match(filename..":(%d+):%s+(.+)")
        editor:GotoLine(tonumber(line) -1) editor:LineEndExtend()  -- go to error line, make it visible, select line
        print("! ["..time().."] Line: "..line..", ERROR: "..errout) io.flush()
    end
end