Working with Documents

Documents

Documents are not created directly, instead create the most appropriate sub-type of document (article, press release, event or profile). This section describes the fields shared by all documents. 

Documents are displayed using "app hooks", special pages that are set up to display documents of a specific type. Each document has a default app hook depending on the insitute that is associated with it (so that Brain Science articles display on the article app hook in the Brain Science section). When a document appears on the site, the link URL for that document links to the app hook assigned to that document unless it has been overridden somehow (for Articles usinge the display_page field, for Events using the "custom page override" field).

Field

Notes

slug

This is a human-readable, URL appropriate identifier for this document. By default this is a "slugified" version of the document's title.

institute

The institute or group that is associated with this document. The choices are selected from the Institutes defined elsewhere in the admin. 

tags

List of tags associated with this document. Comma or space delimited in this field.

title

The title of the document. This could be the headline, title or profile title.

published

Documents must be published to display on the site.

created_by

The user the created this document.

created

The time and date that this document was created.

modified_by

The user that last edited this documet.

modified

The time and date that this document was last edited.

display_date

The publicly viewable date to display for this document. For articles and press releases this should be the publication date of the document. Events and Profiles do not display this field.

display_image

This is the primary image associated with this document. When a document is displayed in a plugin or feed, this will be the image used.

display_label

This is the label associated with this document to indicate its type. Used primarily in the "card" view in content feeds and highlighted content plugins.

 

Articles

Articles can be created and edited through the article admin.

Articles are for news, blogs and other long-form content to appear on the site. Types of articles are differentiated by (optional) tags:

  • News are news items appearing on the site.
  • InTheNews are news items published elsewhere.
  • Video are items that are primarily video content.
  • Blog are items that are part of a blog. These should also have a blog-specific tag (e.g. FGDirectorsBlog)

New tags may be created and used within Content Filters to differentiate documents. Tags are case-sensitive.

In addition to the common fields share with all documents, articles contain the following fields:

Field

Notes

byline

The author or source of the article if it should display on "cards" for this article.

video_url

Link to a YouTube video to display for this article.

external_url_label

If this article is a reference to an external item, this is the label that should be used for links to that item.

external_news_url

If this article is a reference to an external item, this is the URL that should be used for links to that item. If this field is set, it overrides the default URL for this article and links will go to the external site. 

short_description

A rich text field for use as the summary or short version of the article. This is used in some of the "card" views use outside of the main page for this article.

full_description

A rich text field for use as the main body of the article.

display_page

This field allows the default app hook to be overridden for cases where multiple app hooks exist for a given sub-site (such as the Director's Blog).

 

Press Release

Press releases can be created and edited through the press release admin.

In addition to the common fields shared with all documents, press releases also include the following fields:

Field

Notes

sub_title

Sub-title to use when displaying this press release.

pdf

A PDF file may be added to the press release for download.

external_link_label

If this press release is associated with an external news item or release, this is the label to use for links to that item.

external_link_url

If this press release is associated with an external news item or release, this is the URL to use for links to that item.

full_description

A rich text field for use as the main body of the press release.

Events

Events may be edited through the events admin.

In addition to the fields common to all documents, events have the following fields:

Field

Notes

override_page

This field allows the default app hook to be overridden to allow a custom page to be created for this event. The field only lists existing pages, so the custom page should be created before setting this field.

If this field is set, the URL of the selected page will override all links on the site.

start_date

This is the start date for the event.

start_time

This is the start time of the event.

end_date

This is end date for the event. If an event is not a multi-day event, this should be set to the same date as the start date.

end_time

This is the end time of the event.

location

This is the address of the event. This field is used as part of the query for the embedded map, so it should be checked for accuracy using Google Maps before being entered for this event.

sign_up_link

If registration for the event available on an external site, use this field to set the URL. If this field is set, then all links to this event on the site assume that the external site is the canonical URL (unless override_page has been set).

short_description

This is the short description of the event used in promotional plugins and "card" views.

full_description

This is the full description of the event, used as the main body content for the default event page.

agenda

This is a separate rich text field for "more information" regarding the event (such as the schedule of events). This is used as the content of the Event Detail plugin.

cta_button_text

The label text to use for the event call-to-action button.

show_cta_button

Check to display the event call-to-action button in the Event CTA and Featured Event plugins. For past events, this can be unchecked to avoid sending users to the registration page for an event.

recipient_email

E-mail to use for sign-up registrations. This remains for legacy reasons, but has been deprecated in favor of the sign_up_link field.

 

Profiles

Profiles (aka staff member profiles) can be created and edited in the profile admin.

In addition to the common fields shared by all documents, profiles contain the following fields:

Field

Notes

last_name

The last or family name for the profile.

first_name

The first or given name for the profile.

title_suffix

Suffix to apply to the full name (e.g. Ph.D.)

user

If this profile is associated with a specific user account for the admin, use this field to indicate the account.

departments

If this profile belongs to one or more departments, use this field to select them. To create or edit departments to appear in this list, use the departments admin.

pubmed_link

The URL to this profiles PubMed page (if applicable).

resume

A resume file may be uploaded and associated with this profile using this field.

email

The e-mail address of this profile. This will display on the site, so be aware of privacy issues before setting this field.

biography

The bio/description for this profile.

sidebar

Additional, secondary information for this profile. This field will appear in the secondary column of profile pages and in the profile plugin.

research_list

This profile's research may be highlighted by including it in this field. This will appear on the profile's page.

research_description

Additional information regarding this profile's research. This will appear on the profile's page.

publications

Publications associated with a profile may be added here. Publications can be created and edited through the publication admin.

team_image
team_description
team_members

Team information is used to provide a summary or highlight the team associated with a particular profile. Use the Image and Description fields to add team information for team members that do not have their own profiles.