FilePublisher (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
K (hat „FilePublisher“ nach „FilePublisher (Objekt)“ verschoben)
 
(9 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
 
==Name==
 
==Name==
FilePublisher - Publiziert Artikel und Medien als Datei
+
FilePublisher - Publiziert Artikel und Medien als Datei ins Dateisystem
  
 
==Beschreibung==
 
==Beschreibung==
Ein FilePublisher publiziert Artikel und Medien als Datei in das File-System.
+
Ein FilePublisher publiziert Artikel und Medien als Datei ins Dateisystem.
Die Konfiguration des Publishers und der ArticlePool definieren das Verzeichnis, in dem die Datei generiert wird.
+
Die Konfiguration des Publishers und der [[ArticlePool|ArtiklePools]] definieren das Verzeichnis, in dem die Datei generiert wird.
 +
 
 +
Über den File Publisher werden Dateien in das Filesystem geschrieben. Dies ist der Standard-Publisher mit dem eine Website in ein DocumentRoot geschrieben werden kann, die entsprechend in einem Webserver konfiguriert wird. Die Konfiguration des Publishers legt bei der Generierung der Artikel das Encoding (z.B. UTF-8 oder ISO-8859-1) der Dateien fest. Außerdem wird über die konfigurierte Sprache des File-Publishers automatisch der Inhalt aus den Artikeln geladen, der für diese Sprache verfügbar ist. Hierbei wird der allgemeine "Lookup" verwendet, falls einzelne Felder eines Artikels nicht gefüllt sind :
 +
 
 +
Sprache_Land -> Sprache -> default
 +
 
 +
Weiterhin kann über den IO-Tag im verwendeten Template der ContentType (text/xml) definiert werden. Eine Publikation in ein Remote-Filesystem ist nicht direkt über den IES möglich. Hier wird auf klassische Mechanismen bei der Einbindung von Netzwerklaufwerken gesetzt. Je nach technischen Möglichkeiten und Betriebssystem sind hier unterschiedliche Formen denkbar. Diese Form der Einbindung dient der besseren Wartbarkeit und Transparenz.
  
 
==Attribute==
 
==Attribute==
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
Zeile 13: Zeile 19:
 
| id
 
| id
 
| [[ID]]
 
| [[ID]]
| ID des Objektes
+
| ID des Publishers
 
| 1
 
| 1
 
|-
 
|-
| field
+
| type
| [[Variablename]]
+
| [[String]]
| Variablenname des Objektes
+
| Liefert <code>file</code>
 +
| 1
 +
|-
 +
| anchor
 +
| [[Anchor]]
 +
| Anchor des Publishers
 +
| 1
 +
|-
 +
| name
 +
| [[String]]
 +
| Name des Publishers
 
| 1
 
| 1
 
|-
 
|-
| root
+
| encoding
| [[Element]]
+
| [[String]]
| Root-Element dieser Information
+
| Encoding das der Publisher verwenden soll (<code>UTF-8</code>, <code>ISO-8859-15</code>, ...)
 
| 1
 
| 1
 
|-
 
|-
 
| locale
 
| locale
 
| [[Locale]]
 
| [[Locale]]
| Sprache, für die die Information gilt
+
| Die Sprache, die für diesen Publisher verwendet werden soll
 
| 1
 
| 1
 
|-
 
|-
| isEmpty
+
| clients
| [[Boolean]]
+
| [[Collection]]&nbsp;<[[Client]]>
| <code>true</code>, wenn die Größe der Binäredaten <code>0</code> ist
+
| Liste der Mandanten, die Zugriff auf diesen Publisher haben
 
| 1
 
| 1
 
|-
 
|-
| binary
+
| metadata
| [[ID]]
+
| [[Map]]&nbsp;<[[String]],[[String]]>
| ID, unter der die Binäredaten selbst erreichbar sind.
+
| Metadaten eines Publishers
 
| 1
 
| 1
 
|-
 
|-
| filename
+
| metadataString
 
| [[String]]
 
| [[String]]
| Dateiname der binären Daten
+
| Metadaten eines Publishers als Zeichenkette. Jede Zeile ist ein Schlüssel/Werte-Paar, getrennt mit einem = (Gleichheitszeichen)
 
| 1
 
| 1
 
|-
 
|-
| filesize
+
| isPublished
| [[Number]]
+
| [[Boolean]]
| Dateigröße in Bytes
+
| Liefert im Out-Modus  <code>true</code>, wenn der Artikel vom Publisher publiziert wird, oder <code>false</code>, wenn der Artikel vom Publisher depubliziert wird
 
| 1
 
| 1
 
|-
 
|-
| format
+
| documentRoot
 
| [[String]]
 
| [[String]]
| Binärformat (xls)
+
| Das Verzeichnis, in das der <code>FilePublisher</code> schreibt
 
| 1
 
| 1
 
|-
 
|-
| mime
+
| directory
 
| [[String]]
 
| [[String]]
| MIME-Typ (<code>application</code> / <code>excel</code>)
+
| Das Verzeichnis zur Steuerung von Mandanten mit einer URL
 
| 1
 
| 1
 
|-
 
|-
| isImage
+
| url
| [[Boolean]]
+
| [[String]]
| Liefert immer <code>false</code>
+
| Die URL des Publishers
 
| 1
 
| 1
 
|-
 
|-
| isExcel
+
| schemeType
| [[Boolean]]
+
| [[String]]
| Liefert immer <code>true</code>
+
| Falls Schemes verwendet werden, gibt dieser Wert an, wo im Dateinamen die Zeichenkette eingefügt werden soll
 
| 1
 
| 1
 
|-
 
|-
| sheets
+
| schemeValue
| [[Collection]]
+
| [[String]]
| Liste der ExcelSheet-Objekte
+
| Die Zeichenkette die bei Verwendung von Schemes eingefügt werden soll
 
| 1
 
| 1
 
|}
 
|}
Zeile 79: Zeile 95:
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
[[Category:Qualität_des_Inhalts_prüfen]]
 
[[Category:Qualität_der_Sprache_prüfen]]
 
 
[[Category:Qualität_des_Codes_prüfen]]
 
[[Category:Qualität_des_Codes_prüfen]]
 
</noinclude>
 
</noinclude>

Aktuelle Version vom 3. November 2010, 13:08 Uhr

Name

FilePublisher - Publiziert Artikel und Medien als Datei ins Dateisystem

Beschreibung

Ein FilePublisher publiziert Artikel und Medien als Datei ins Dateisystem. Die Konfiguration des Publishers und der ArtiklePools definieren das Verzeichnis, in dem die Datei generiert wird.

Über den File Publisher werden Dateien in das Filesystem geschrieben. Dies ist der Standard-Publisher mit dem eine Website in ein DocumentRoot geschrieben werden kann, die entsprechend in einem Webserver konfiguriert wird. Die Konfiguration des Publishers legt bei der Generierung der Artikel das Encoding (z.B. UTF-8 oder ISO-8859-1) der Dateien fest. Außerdem wird über die konfigurierte Sprache des File-Publishers automatisch der Inhalt aus den Artikeln geladen, der für diese Sprache verfügbar ist. Hierbei wird der allgemeine "Lookup" verwendet, falls einzelne Felder eines Artikels nicht gefüllt sind :

Sprache_Land -> Sprache -> default

Weiterhin kann über den IO-Tag im verwendeten Template der ContentType (text/xml) definiert werden. Eine Publikation in ein Remote-Filesystem ist nicht direkt über den IES möglich. Hier wird auf klassische Mechanismen bei der Einbindung von Netzwerklaufwerken gesetzt. Je nach technischen Möglichkeiten und Betriebssystem sind hier unterschiedliche Formen denkbar. Diese Form der Einbindung dient der besseren Wartbarkeit und Transparenz.

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID des Publishers 1
type String Liefert file 1
anchor Anchor Anchor des Publishers 1
name String Name des Publishers 1
encoding String Encoding das der Publisher verwenden soll (UTF-8, ISO-8859-15, ...) 1
locale Locale Die Sprache, die für diesen Publisher verwendet werden soll 1
clients Collection <Client> Liste der Mandanten, die Zugriff auf diesen Publisher haben 1
metadata Map <String,String> Metadaten eines Publishers 1
metadataString String Metadaten eines Publishers als Zeichenkette. Jede Zeile ist ein Schlüssel/Werte-Paar, getrennt mit einem = (Gleichheitszeichen) 1
isPublished Boolean Liefert im Out-Modus true, wenn der Artikel vom Publisher publiziert wird, oder false, wenn der Artikel vom Publisher depubliziert wird 1
documentRoot String Das Verzeichnis, in das der FilePublisher schreibt 1
directory String Das Verzeichnis zur Steuerung von Mandanten mit einer URL 1
url String Die URL des Publishers 1
schemeType String Falls Schemes verwendet werden, gibt dieser Wert an, wo im Dateinamen die Zeichenkette eingefügt werden soll 1
schemeValue String Die Zeichenkette die bei Verwendung von Schemes eingefügt werden soll 1