Wie erstelle ich eine Handbuchseite?
Howto make a handbool page?
Anleitungen
Howto
Rechenblätter erstellen und bearbeiten
SMath Studio documents
Inhalt
Contents
Eine Handbuchseite ist eine ganz normale SMath Studio Datei (Endung .sm) Beachten Sie: alle Dateien liegen in einem Verzeichnis. Benutzen Sie aussagekräftige Namen. Funktionsbeschreibungen verwenden den Namen der Funktion als Dateinamen. Damit können diese Seiten in späteren SMath Versionen mit F1 aufgerufen werden. Da Windows Groß- und Kleinbuchstaben in Dateinamen zwar anzeigen, nicht aber intern unterscheiden kann, ist im Konfliktfall eine spezielle Markierung notwendig. - Kleinschreibung wird direkt übernommen - Großsschreibung wird durch einen vorangestellten Unterstrich gekennzeichnet. Beispiel: min() -> min.sm, Min() -> _Min.sm
A handbook page is an ordinary SMath Studio file (extension .sm). When choosing file names, keep in mind that all pages reside in a single directory. Try to use descriptive names. Function names are reserved for the description of that functions. In later SMath releases, these could be automatically called via F1. Unfortunately, the Windows file names are not case sensitive even if the names are displayed correctly, Min.sm and min.sm are the same file and cannot co-exist. Therefore, capital letters have to be preceeded by an underscore in case of conflict. Example: min() -> min.sm. Min() -> _Min.sm
Suchen Sie sich für Ihre Seite eine passende Vorlage unter den existierenden Seiten aus und speichern Sie diese unter dem neuen Namen.
Find a suitable template for your page among the existing pages and save that under the new name.
Vorlage: Funktionsbeschreibung (Funktion aus Plugin)
Template: Description of function from plugin
Vorlage: Funktionsbeschreibung
Template: Description of function
Vorlage: Pluginbeschreibung
Template: Description of a plugin
Füllen Sie die Seite mit Inhalt. Beachten Sie, dass fast jedes Objekt mehrsprachig sein kann. Der Zugriff auf die einzelnen Sprachversionen geht über das Kontextmenü des jeweiligen Objekts.
Fill the page with content regions. Note that nearly every object can be multi-lingual. For access to the individual language versions, use the context menu of the respective objects.
Verwenden Sie Textformatierungen extrem zurückhaltend. Lassen Sie die Schriftgröße auf dem Standardwert.
Use text formattings with care. Do not change the default font size.
Handbuchseiten sollten nicht zu lang sein, teilen Sie den Inhalt gegebenenfalls in mehrere hierarchisch strukturierte Blätter auf.
Handbook pages should be compact. Split larger contents into a nested structure of interlinked pages.
Hinzufügen von Links
How to add links to other pages
Links sind Textbereiche mit dem zusätzlichen Attribut "href"
Links are simply text regions with the attribute "href" added.
Inhalt
Contents
1. Kopieren Sie einfach einen bestehenden Link, ändern Sie den Text in SMath. Sie können auch hier verschiedene Sprachversionen bereitstellen. 2. Speichern Sie dann das Blatt und öffnen Sie es in Ihrem Lieblings-Texteditor. Wenn möglich, verwenden Sie xml-Syntax-Highlighting. 3. Suchen Sie den Textbereich (anhand des Textes) und ändern Sie das Link-Ziel. 4. Speichern Sie die Datei im Editor. 5. Öffnen Sie die Datei in SMath. Der Link zeigt nun auf das richtige Ziel.
1. Just copy an existing link and change the text within SMath. You may again provide several language versions. 2. Then save the sheet and open it in your favorite text editor, best with xml syntax highlighting 3. Find the correct text region (by contents or context) and edit the file name. 4. Save the file in the editor. 5. Re-open the file in SMath. The link now points to the correct file.
Links auf bereits bestehende Dateien (z.B. Inhaltsverzeichnis, Funktionsindex) sind meist in der Vorlage bereits enthalten.
The templates already contain links to some existing pages (like contents or function index.
Links, deren Ziel noch nicht existiert, sollten grau hinterlegt werden
Stale links (with dead target) should be marked with gray background.
Beschreibung von Benutzereingaben
Description of user interaction
Menüaktionen werden in Fettschrift mit einem > als Trennzeichen geschrieben.
Menu actions are written in boldface with > as delimiter.
Einfügen> Hyperlink
Insert> Hyperlink
Tastatureingaben werden durch ein Symbol gekennzeichnet. Daneben folgt der einzu gebende Text. Sondertasten werden eingerahmt. Gleichzeitig zu drückende Tasten werden mit einem + verbunden
Keyboard input is indicated by a keyboard symbol, followed by the text to be typed. Special keys are boxed. If keys are to be pressed at the same time, they are connected by a + sign
5+3^2
Strg
Ctrl
+
H
oder
or
Strg+H
Ctrl+H
Sondertasten:
Special keys
Pfeiltasten
Arrow keys
↓
→
Eingabetaste
Enter key
Enter
Umschalttaste
Shift key
Shift
Steuerungstaste
Control key
Strg
Ctrl
Tabulator-Taste
Tabulator key
Tab
Leertaste
Space bar
Leer
Space
Rücktaste
Backspace
│ │ │ │ │ │ │ │ │ │ │ │ │
Sonderzeichen kann man der Windows Zeichentabelle entnehmen:
Special characters can be taken from the Windows character map.
Rechts finden Sie z.B. einen Textbereich mit vertikalen Rahmenelementen, z.B. für die Spaltentrennung in Tabellen
To the right you find a vertical line built with spechial characters. This may be useful as column delimiter in tables.
Eingabe von Unicode-Zeichen
Input of unicode characters
Rechenblätter erstellen und bearbeiten
SMath Studio documents
Anleitungen
Howto
Inhalt
Contents
$Author: mkraska $ $Date: 2013-09-29 02:42:17 +0200 (So, 29. Sep 2013) $