Difference between revisions of "Open-Xchange Publishing"

(Open-Xchange Internal data structures to access with FreeMarker)
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
= Publishing Data with Open-Xchange =
+
The publish mechanism was replaced with version 7.8.0 by the '''''Sharing and Guest Mode'''''. See [https://documentation.open-xchange.com/7.10.2/middleware/miscellaneous/sharing_and_guest_mode.html documentation.open-xchange.com] for details.
 
 
Open-Xchange offers to publish an increasing amount of internal data like contacts, documents, appointments. This data can be published in a way that it is machine-readable using [http://oxmf.org OXMF] and it can be customized in it's look and feel using common web techniques like CSS.
 
 
 
Open-Xchange is using the [http://freemarker.org/ FreeMarker Template Engine] to export the internal date to the published templates. Check the [http://freemarker.org/docs/index.html FreeMarker Manual] on how to use it.
 
 
 
== Open-Xchange Internal data structures to access with FreeMarker ==
 
 
 
=== Contacts ===
 
Within freemarker, you are given a list called <tt>contacts</tt>, which contains all contacts of the given publication. This is the central element of the publication. Freemarker enables you to access every attribute of the class Contact that has both a setter and a getter. See the JavaDoc for the class to find out about attributes or use the example template of your OX.
 
 
 
==== Examples ====
 
This is the basic loop over the list of contacts that you get:
 
  &lt;#list contacts as contact&gt;
 
      &lt;div class="ox_contact"&gt;
 
        &lt;span class="ox_company"&gt;$contact.company&lt;/span&gt;
 
        &lt;span class="ox_company"&gt;$contact.uRL&lt;/span&gt;
 
        &lt;span class="ox_note"&gt;$contact.note&lt;/span>
 
      &lt;/div&gt;
 
  &lt;/#list&gt;
 
 
 
==== Additional fields ====
 
 
 
{|
 
! Variable !! Description
 
|-
 
| contacts
 
| As already mentioned: A list of contacts that are supposed to be published. Central part of the publishing process.
 
|-
 
| publication
 
| The complete publication object.
 
|-
 
| request
 
| The http request that was sent to show this publication.
 
|-
 
| dateFormat
 
| The format of the date, usually in the java.text.SimpleDateFormat.
 
|-
 
| timeFormat
 
| Like date format, just for displaying times during the day (without the year, month or day).
 
|-
 
| privacy
 
| The privacy text meant to be published on the displayed page (*).
 
|-
 
| userContact
 
| The contact that is responsible for the publication of this page (*).
 
|}
 
 
 
(*) Note: Several countries legally require you to publish this information. Leave it out at your own peril.
 
 
 
== Changing the default templates ==
 
 
 
The default templates of all existing items to publish can be found in the folder <tt>/opt/open-xchange/templates/</tt> of every Open-Xchange installation, if the package '''open-xchange-publish-microformats''' is installed:
 
 
 
$ dpkg -L open-xchange-publish-microformats | grep templates
 
/opt/open-xchange/templates
 
/opt/open-xchange/templates/contacts_oxmf_uncensored.tmpl
 
/opt/open-xchange/templates/infostore.tmpl
 
/opt/open-xchange/templates/contacts_hcard_censored.tmpl
 
/opt/open-xchange/templates/contacts_oxmf_censored.tmpl
 
/opt/open-xchange/templates/contacts.tmpl
 
/opt/open-xchange/templates/contacts_hcard_uncensored.tmpl
 
 
 
When these files are changed, new published items in Open-Xchange will get this look and feel. Check out the online help or the [http://software.open-xchange.com/OX6/doc/ user guides] on how to publish using Open-Xchange.
 

Latest revision as of 08:54, 15 May 2019

The publish mechanism was replaced with version 7.8.0 by the Sharing and Guest Mode. See documentation.open-xchange.com for details.