Index • ProjectProjekt • ConfigurationKonfiguration
|
2014-07-06 09:35

ConfigurationKonfiguration

hagen.config

(Won't appear in the project tree)

Global config file which are stored in different directories according to the operating system (Linux: ~/.config/Hagen / Windows: %user%\Local Settings\Application Data\Hagen). If you want to use Hagen from a usb stick, you can store this file in the same directory like Hagen itself.

At the moment Hagen will store the project directory in this file.

(Taucht nicht im Projektbaum auf)

Globale Konfigurationsdatei die je nach System in unterschiedlichen Verzeichnissen liegen kann (Linux: ~/.config/Hagen / Windows: %user%\Local Settings\Application Data\Hagen). Wenn sie Hagen von einem USB-Stick benutzen wollen, können sie diese Datei im selben Verzeichnis wie Hagen speichern.

Hier speichert Hagen im Moment nur das aktuelle Projektverzeichnis.

project.hagen

(Won't appear in the project tree)

Stores the project tree.

(Taucht nicht im Projektbaum auf)

Speichert den Projektbaum.

position.list

(Won't appear in the project tree, but you can insert it if you want)

Stores the cursor positions of the text files.

(Taucht nicht im Projektbaum auf, aber sie können es einfügen)

Speichert die Cursor-Position der Textdateien.

references.list

(Won't appear in the project tree, but you can insert it if you want)

Stores the references for internal links.

(Taucht nicht im Projektbaum auf, aber sie können es einfügen)

Speichert die Referenzen für interne Links.

preferences.list

Config file of the project.

Hagen will store here things like:

app_max=1
Starts Hagen maximized
menu_level=3
Maximum level of the menu
bigpage_name=printpage
Name of the printing page
output_dir=website
Output directory for the generated html files
images_dir=images
Images directory below „output_dir“
stylesheet_name=stylesheet.css
Name of the default stylesheet
internetbrowser=firefox
Name of the webbrowsers für Project / Show
template_name=template.html
Name of the default template
write_debug_file=1
Write debug into file „hagen_debug.log“
ref_var_name=none
Variablename the internal reference dialog will return
ref_img_name=none
Variablename the image dialog will return
ext_command1=Name:Command Param
External Commands for the menu „Command“

Lokale Konfigurationsdatei des Projektes.

Hier speichert Hagen Projektinterna wie:

app_max=1
Hagen maximiert starten.
menu_level=3
Maximale Ebene für das Menü.
bigpage_name=Druckseite
Name der Druckseite.
output_dir=website
Ausgabeverzeichnis für den generierten HTML-Quelltext.
images_dir=images
Bilderverzeichnis unterhalb von „output_dir“.
stylesheet_name=stylesheet.css
Name des Standard Stylesheet.
internetbrowser=firefox
Name des Webbrowsers für Project / Show
template_name=template.html
Name des Standard Template
write_debug_file=1
Debug in Datei „hagen_debug.log“ ausgeben.
ref_var_name=none
Variablenname den der internal reference Dialog zurückgibt
ref_img_name=none
Variablenname den der Bilderdialog zurückgibt
ext_command1=Name:Befehl Param
Externe Befehle für das Menü „Command“

variables.list

You can define variables and functions here.

  • *author*=
    Fill in your own name.
  • *pagetitle*=
    Fill in your websites name.
  • *subtitle*=
    Not used yet

You can put your own variables to these file, and use them in the source files and in the template.

  • *own_variable*=Text for these variable
  • *second_variable*=Another Text to replace

Variables will be replaced like a text processor „replace dialog“ in the text files. For that purpose a list of local variables (see SourcecodeQuellcode) and the file variables.list (in this order) will be created and then sequencially worked off. Because of this the order of the list will have a priority.

You can define variables with parameters (functions):

  • *mark*=<span class="mark"> %%0%% *</span>
    %%0%% is the position where the first parameter will be inserted. In the source code it will called with „*mark*((Parameter1))“ and in the generated html file will appear „<span class="mark"> Parameter1 </span>“.
  • *a_wiki*=<a href="http://de.wikipedia.org/wiki/%%0%%"> %%1%% </a>
    This function will be called with two parameters: *a_wiki*((MarkDown|MarkDown))

Instead of the double round brackets (()) you can use square [[]], curly {{}} or angle <<>>. It is the only way to nest functions.

Hier können sie Variablen und Funktionen definieren.

  • *author*=
    Tragen sie hier den eigenen Namen ein.
  • *pagetitle*=
    Tragen sie hier den Namen der Webpräsenz ein.
  • *subtitle*=
    zur Zeit noch nicht benutzt

Sie können auch beliebige eigene Variablen anlegen, die sie dann im Quelltext und im Template verwenden können.

  • *eigene_variable*=Text für diese Variable
  • *zweite_variable*=Noch ein ersetzender Text

Variablen werden wie bei einer Textverarbeitung durch „Suchen und Ersetzen“ in den Dateien ersetzt. Dazu wird eine Liste von lokalen Variablen (s. SourcecodeQuellcode) sowie der Datei variables.list (in dieser Reihenfolge) erstellt und dann nacheinander abgearbeitet. Damit ergibt sich eine Priorisierung der Variablen in dieser Reihenfolge.

Sie können auch Variablen mit Parametern (dann eigentlich Funktionen) definieren:

  • *mark*=<span class="mark"> %%0%% </span>
    %%0%% bezeichnet die Stelle, an der der erste Parameter eingefügt wird. Im Quelltext erfolgt der Aufruf mit „*mark*((Parameter1))“ und in der generierten HTML-Datei erscheint „<span class="mark"> Parameter1 </span>“.
  • *a_wiki*=<a href="http://de.wikipedia.org/wiki/%%0%%"> %%1%% </a>
    Hier erfolgt der Aufruf mit zwei Parametern: *a_wiki*((MarkDown|MarkDown))

Anstatt der doppelten runden Klammer (()) können sie auch doppelte eckige [[]], geschweifte {{}} oder spitze <<>> benutzen. Nur so können sie Funktionen schachteln.

variables_bigpage.list

If this file exists a bigpage (printing page) will be generated.

In this file you can overwrite varibles defined in „variables.list“. For example you can make links visible: *a_wiki*=%%1%% (http://en.wikipedia.org/wiki/%%0%%)

Wenn diese Datei existiert, wird die Bigpage (Druckseite) generiert.

Hier können sie Variablen der Datei "variables.list" überschreiben. Und so beispielsweise Links sichtbar ausdrucken: *a_wiki*=%%1%% (http://de.wikipedia.org/wiki/%%0%%)

autocomplete.list

In this file you can define expressions which the editor will replace automatically when you press Shift + Space.

Definition example:
p
=<p>|</p>

Keystrokes in the editor:
P, Shift + Space

Output in the editor:
<p>|</p>
(Cursor blinks between > and <).

Hier können Ausdrücke definieren, die der Editor nach drücken von Shift + Leertaste automatisch umwandelt.

Beispiel Definition:
p
=<p>|</p>

Eingabe im Editor:
P, Shift + Leertaste

Ausgabe im Editor:
<p>|</p>
(Der Cursor blinkt zwischen > und <).

stylesheet.css

You will use the stylesheet in the common way with selectors, properties and formats.

However Hagen will use some internal classes, you will easily find inside the source code of the generated side. The most important class is „hagen_error“ which will highlight errors in the source code.

Im Stylesheet geben sie ganz normal die Selektoren für Formatierungen an.

Allerdings verwendet Hagen einige interne Klassen, die sie am einfachsten im Quellcode der generierten Seite herausfinden. Am wichtigsten ist die Klasse „hagen_error“ die Fehler im Quelltext hervorheben soll.

.hagen_error { background-color: red; }