uio--WebPageHeader-Module
uio--WebPageMain-Module

Overview

Das <ce:WebPage> ist eines der wichtigsten CEs in UDS: Mit diesem Content Element ist es möglich, eine Einzelseite einer Webseite zu definieren.

Damit ein solche Seite allerdings anschließend auch im Browser adressiert werden kann, muss diese <ce:WebPage> Instanz noch mit einer <Route> in der <RouteDefinition> verlinkt werden.

Structure

Struktur einer WebPage



<?xml version="1.0" encoding="UTF-8"?>
<doc
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://snewmedia.com/snm/uio3/specs/ce ce.xsd"
  xmlns:ce="http://snewmedia.com/snm/uio3/specs/ce"
  xmlns="http://snewmedia.com/snm/uio3/specs/default"
>
  <ce:WebPage>
    <ce:config>
     <!-- Configuration -->
    </ce:config>
    <ce:contents>
     <!-- Contents -->
    </ce:contents>
  </ce:WebPage>
</doc>

                        

Erläuterung

doc

Das <doc> dient nur als Container für andere Elemente, darunter in diesem Fall einem <ce:WebPage> Element.

Die zugehörigen Namespaces basierend hier auf einem SNEWMEDIA Standard. Sie haben vom Prinzip die Option, eigene CEs zu definieren.

ce:WebPage

Ein <ce:WebPage> gliedert sich primär in zwei Bereiche: <ce:config> Definitionen sowie dem <ce:contents> Element als Container für die eigentlichen Inhalte einer Webseite.

Konfiguration

<ce:config> Element

Das <ce:config> Element beinhaltet die Konfiguration von Properties und damit von Eigenschaften einer <ce:WebPage> Instanz.

Auf übliche Eigenschaften der Konfiguration wird gesondert eingegangen.

<ce:contents> Element

Das <ce:contents> Element ist der Container für alle Inhalte dieser WebPage, darunter mitunter den WebPageHeader, WebPageMain und WebPageFooter.

Auf die Details wird gesondert eingegangen.

ce:config

Inhalte der Konfiguration



    <ce:config>
      <ce:name>ce:WebPage</ce:name>
      <ce:title>ce:WebPage</ce:title>
      <ce:description>ce:WebPage</ce:description>
      <ce:isPartOf>
        <ce:WebSite
         ref="/Realm/uio3.com/_nodes/WebSite__@uio3__UDS_V24A.xml">
        </ce:WebSite>
      </ce:isPartOf>
      <ce:language_key>de</ce:language_key>
      <ce:author>T2M</ce:author>
    </ce:config>

                        

Erläuterung

ce:config

Das <ce:config> Element dient als Container für die Definition von werden für eine Reihe von Eigenschaften, über die jede Webseite als Einzelseite einer Website verfügen sollte.

Wichtige Eigenschaften

Eine sehr wichtige Konfiguration ist der <ce:isPartOf> Wert. Dieser gibt die semantische Verknüpfung zwischen einer ce:WebPage Instanz und einer zugehörigen ce:WebSite Instanz als Gruppierungselement an.

Status: alpha

Geplante Änderungen

Die Verwendung von ce:config und ce:contents ist für die meisten Content Elements, kurz CE, ein Standard seit UDS v.1.5.2.x und wurde auch rückwirkend für ce:WebPage Elemente geschaffen.

Für die Berücksichtigung einer Vielzahl weiterer Properties aus dem Schema wird auch das ce:WebPage Element um ein ce:properties Element erweitert werden, um eine typisierte Erfassung weiterer Informationen für eine semantische Verknüpfung ermöglichen zu können.

title

ce:title: Der Titel entspricht dem HTML TITLE Element. Dieser wird später in einem Browserfenster oben im Reiter im Browser angezeigt.

Diese Property gibt es auch in schema.org für CreativeWorks Instanzen.

Status: alpha

Der ce:title wird bislang ohne Typisierung und ohne Auswertung der Sprache erfasst.

Mit Einführung von ce:properties wird der Titel einer WebPage demnach als text-Element typisiert werden.

ce:name

ce:name: Dieses Element dient für eine Kurzbezeichnung dieser WebPage Instanz. Es handelt sich zumeist um einen verkürzten Titel.

Diese Property wurde geschaffen für LinkedData in Anlehnung an SchemaOrg.

Status: alpha

ce:description

ValueType: xs:string

ce:description: Die ce:description entspricht dem HTML META Tag für die description, welche in Google verwendet wird.

Die Eingabe des Wertes entspricht einem normalen String bzw. XML TextNode.

Auch in schema.org gibt es eine entsprechende Property im Falle von Thing Instanzen.

Status: alpha

Die ce:description Eigenschaft ist sehr wichtig weil diese im Suchergebnis in Suchmaschinen wie bei Google die Kurzbeschreibung von ca. 90-120 Zeichen beinhaltet.

Diese Description ist allerdings eigentlich auch eine Property im Schema für Thing-Objekte und müsste dahingehend mit Einführung von ce:properties auch als text-Wert typisiert werden.

ce:keywords

ValueType: xs:string

ce:keywords: Die ce:keywords Definition entspricht dem HTML META Tag für die keywords, welche in Google verwendet werden.

Die Eingabe des Wertes entspricht einem normalen String bzw. XML TextNode.

Auch in schema.org gibt es eine entsprechende Property im Falle von CreativeWorks Instanzen.

Status: alpha

Für die Keywords wurde inzwischen ein KeywordsPermutationModule programmiert, um nicht ständig alle Stichworte von Hand schreiben zu müssen.

ce:isPartOf

ValueType: ce:WebSite.ref

ce:isPartOf: Eine WebPage-Instanz ist immer Teil einer WebSite-Instanz. Das hat damit zu tun, dass Einstellungen für Theme- und Style sowie das Menü im Seitenkopf, der Footer oder auch das Logo über die WebSite als Gruppierungsinstanz definiert wird.

Diese Eigenschaft ist SchemaOrg entlehnt worden und dient für die Definition eines semantischen Zusammenhangs zwischen WebPage und WebSite.

Status: alpha

Ein Wert für diese Eigenschaft ist wichtig.

ce:contents

ce:WebPageHeader

Das <ce:WebPageHeader> Element ist optional. Wenn es verwendet wird so wird hier zumeist eine Slideshow im Seitenkopf definiert.



<ce:WebPage>
 <ce:contents>

  <ce:WebPageHeader>
   <ce:config></ce:config>
   <ce:contents>
    <!-- Hier Slideshow -->
   </ce:contents>
  </ce:WebPageHeader>
  
  <ce:WebPageMain>
   <ce:config></ce:config>
    <ce:contents>

     <HTMLBODY_HEADLINE_010_Section_Breadcrumb_Title>
      <Headline><text lang="de">ce:WebPage</text></Headline>
      <Paragraph>
       <text lang="de">ce:WebPage</text>
      </Paragraph>
      <Navigation>
       <Continue>
        <Link>
         <text lang="de">de/uio3-docs/uds/components/WebPage#contentBegin</text>
        </Link>
       </Continue>
       <AncestorUp>
        <Link>
         <text lang="de">de/uio3-docs/uds/components</text>
        </Link>
       </AncestorUp>
       <Previous>
        <Link>
         <text lang="de">de/@snm/docs/cs/cs-overview</text>
        </Link>
       </Previous>
       <Next>
        <Link>
         <text lang="de">de/@snm/docs/cs/cs-basics/cs-programmstruktur</text>
       </Link>
      </Next>
     </Navigation>
    </HTMLBODY_HEADLINE_010_Section_Breadcrumb_Title>

    <ce:JumpLanding id="contentBegin"></ce:JumpLanding>

    <HTMLBODY_MAIN_CONTENT_010_Section_Overview>  
    <!-- .... -->
    </HTMLBODY_MAIN_CONTENT_010_Section_Overview>  

    <ce:ContentReference 
      uri="/Realm/example.com/_ContentInstances/cblock-CallToActionFinally-@***-create.xml"/>
    
   </ce:contents>
  </ce:WebPageMain>

  <ce:WebPageFooter>
  </ce:WebPageFooter>
 </ce:contents>
</ce:Webpage>      

                        

ce:WebPageHeader

Das ce:WebPageHeader Element ist ein Container für alle CEs welche der visuellen Gestaltung des Seitenkopfs dienen. Hierbei kann es sich beispielsweise um eine Slideshow handelt.

ce:WebPageMain

ce:WebPageMain Element beinhaltet die eigentlichen Inhalte einer ce:WebPage Instanz. Dieses entspricht sinngemäß dem <main> Element in HTML.

In diesem Element werden WebPageMainElement artige Elemente definiert welche wiederum der Container für <ce:Section> Elemente sind welche schlussendlich das eigentliche Layout mit <CEContainer> und dergleichen beinhalten können.

ce:WebPageFooter

Das ce:WebPageFooter Element beinhaltet den eigentlichen Seitenfuß einer ce:WebPage Instanz.

ce:isPartOf