DG Calendar Page

The DG Calendar Page is now a page type. So, as with any page object, it appears in the structure editor and you can set its typical page properties (like template, CSS, etc).

In addition, it has some properties of its own that allow you to define more precisely how the DG Calendar Page looks and behaves.

Content

• Creating a DG Calendar Page
• Editing DG Calendar Page Properties
• Editing DG Calendar Templates
  • Simple-macro Calls
• Editing DG Calendar Conversation Preferences

Creating a DG Calendar Page

A DG Calendar Page has been created automatically in your site, at "/yourSite/calendar". So you may choose to skip this section for now.

To create a new DG Calendar Page, go to the structure editor of your site: "/yourSite/admin/conversations/yourSite/structure", and select the folder in which you want to create the page.

In this folder's properties editor, scroll the window all the way down, until you get the "New File Or Folder" form. Type the name you want to give to your page in "Navigation Title". Set "Page Type" to "DG Calendar Page" and click on "Create New File".

The page will reload and show you a confirmation that the new object has been created. Locate this object in the structure listing and click on it. This will open the properties editor for your DG Calendar Page.

Back to top.

Editing DG Calendar Page Properties

Go to the structure editor of your site and click on your calendar page's name in the listing. Then, click on the "Options" tab.

You're now presented with the following page properties:

• List Messages

  This popup menu lets you specify whether the DG Calendar page should list only messages which are new, edited, or both types.

• Default View

  This is the default view of the DG Calendar page.

• Author Column

  Allows you to choose if the Author column of edited messages will show the author's name or the modifier's name.

• New Message Flag

  This is the text that will be used for the "New" message flag. Of course, you may set it to an image tag.

• Edited Message Flag

  This is the text that will be used for the "Edit" message flag. Of course, you may set it to an image tag.

• New and Edited Message Flag

  This is the text that will be used for the "Both" message flag. Of course, you may set it to an image tag.

Now click on the "Templates" tabl, and you're presented with the final two page properties:

• List Day Page Template

  This template describes the layout of portion of the web page which is specific to the DG Calendar. This includes at least the positions of the Nav Calendar and the list of messages.

• List Day Items Template

  Each message passes thru this template before being displayed in the main body of the page.

Back to top.

Editing DG Calendar Templates

The templates allow you to define how your calendar page will look and behave. You may want to reorder the columns, for example, and/or to remove some of them. You'd do it from the templates.

Beside the main template defined at the top of the File Properties, in which the whole page flows, you have two templates to control the content of the page:

List Day Items Template defines how each story will appear. All the stories pass thru this template before being concatenated, and the resulting string is embeded into the List Day Page Template. By default, the DG Calendar page is built into an html table, so the Page Template defines the header of this table, and the Items Template defines each row.

As usual, the data is inserted into the templates with simple-macro calls (and as usual they're built on the form <!--#macroName-->).

Macros Provided by the DG Calendar

• In List Day Items Template
  
  
  • listDayStatusCellClass
    Replaced with the name of the CSS class to use in the td tag of the Read Flag column (Note: it changes depending on the sort order and the row: "listDayCell", "listDayAltCell", "listDaySortedCell", or "listDayAltSortedCell").
    
    
  • listDayMsgStatus
    Replaced with the message's value for the Read Flag column (a red or yellow dot icon).
    
    
  • listDaySubjectCellClass
    Replaced with the name of the CSS class to use in the td tag of the Subject column (see the note above).
    
    
  • listDayMsgSubject
    Replaced with the message's value for the Subject column (if the page is viewed by subject, the text will be indented to reflect the thread hierarchy).
    
    
  • listDayNumCellClass
    Replaced with the name of the CSS class to use in the td tag of the Msg Num (#) column (see the note above).
    
    
  • listDayMsgNum
    Replaced with the message's value for the Msg Num (#) column.
    
    
  • listDayAuthorCellClass
    Replaced with the name of the CSS class to use in the td tag of the Author column (see the note above).
    
    
  • listDayMsgAuthorAddress
    Replaced with the email address of the author (or modifier) or the message.
    
    
  • listDayMsgAuthorName
    Replaced with the name of the author (or modifier) or the message.
    
    
  • listDayNewCellClass
    Replaced with the name of the CSS class to use in the td tag of the New/Edit column (see the note above).
    
    
  • listDayMsgNew
    Replaced with the message's value for the New/Edit column (as defined in the page properties).
    
    
  • listDayPostedCellClass
    Replaced with the name of the CSS class to use in the td tag of the Posted column (see the note above).
    
    
  • listDayMsgPosted
    Replaced with the message's value for the Posted column (the posted time).
    
    
  • listDayReadsCellClass
    Replaced with the name of the CSS class to use in the td tag of the Reads column (see the note above).
    
    
  • listDayMsgReads
    Replaced with the message's value for the Reads column (a number indicating how many times the message has been read).
    
    
  • listDayAttachCellClass
    Replaced with the name of the CSS class to use in the td tag of the Reads column (see the note above).
    
    
  • listDayMsgAttach
    Replaced with the message's value for the Attachment column (the number of attached files).
    
    
• In List Day Page Template
  
  
  • listDayDate
    Replaced with the date of the displayed day.
    
    
  • listDayStatusSortLink
    Replaced with the link for sorting the messages by Read Flag.
    
    
  • listDaySubjectSortLink
    Replaced with the link for sorting the messages by Subject.
    
    
  • listDayNumSortLink
    Replaced with the link for sorting the messages by Msg Num (#).
    
    
  • listDayAuthorSortLink
    Replaced with the link for sorting the messages by Author.
    
    
  • listDayNewSortLink
    Replaced with the link for sorting the messages by New/Edit.
    
    
  • listDayPostedSortLink
    Replaced with the link for sorting the messages by Posted.
    
    
  • listDayReadsSortLink
    Replaced with the link for sorting the messages by Reads.
    
    
  • listDayAttachSortLink
    Replaced with the link for sorting the messages by Attachment.
    
    
  • listDayBody
    Replaced with the messages listing (built from the items template). Required.
    
    
• In any template
  
  
  • navCalendar
    Replaced with the navigation calendar (if it's enabled - see the next section, Editing DG Calendar Conversation Preferences.)
    You may use this macro call in any template, but it's a little special: If you provide your DG Calendar Page's path as parameter (for example <!--#navCalendar path="calendar"-->), it will be displayed in any page. If you don't set the parameter (<!--#navCalendar-->), it will be displayed only in DG Calendar Pages. See the Navigation Calendar docs for more info about the navigation calendar.
    
    

Back to top.

Editing DG Calendar Conversation Preferences

The DG Plugin has a preference that affect the Calendar Page.

Go to "/yourSite/admin/conversations/free-conversant/preferences$conversation=yourSite&plugin;=Default%20DG".

Scroll the window down until you find the "Available Preferences" section.

• Remember which messages a member has read?
  Set this to false if you don't want to display a flag showing to the users which messages they've seen, which are new and which were edited.

Controling the navigation Calendar is also done from this screen. See Navigation Calendar Documentation for more info.

Back to top.