Setting up the Article Module

TODO: review these notes

Read through the entire document before starting any work!

Note: Assumes website has been created! If there's no existing website see Create a new Website.

Note: this document sets up the Articles module and Website blocks. See "Article Creation" to create the actual articles.

Articles Module

When setting up the articles publishing workflow for a website take into account the following:

1. If only one person writes, edits and publishes the articles, a simple workflow suffices.
2. If the group process is informal, and no one has to approve articles for publishing, a simple workflow suffices.
3. If there is a formal workflow of approving articles before publishing (or translating), then the workflow should probably use the approval workflow.
4. If some users are authors, some are editors, some are publishers, etc. And an author cannot publish to the website directly, then use the approval workflow.

Simple workflow: Article Module setup

• Expand the Articles module, click on "Articles settings".
• Fields: you can adjust the default available fields of the article. Initially just leave it for now and adjust fields later if needed.
• Workflow: Leave all fields unchecked.
• Share: Unless required not to share, don't make any changes. (Everything shared by default)
• Article types: Initially just leave it for now and adjust fields later if needed.

Approval workflow: Article Module setup

• Expand the Articles module, click on "Articles settings".
• Fields: you can adjust the default available fields of the article. Initially just leave it for now and adjust fields later if needed.
• Workflow: Take a look at these fields and determine which settings need to be activated.
  • Approval workflow
  • Use the approval workflow: if you have dedicated editors, and authors are not allowed to publish directly to website.
  • Authors can edit once 'done' or 'approved' articles: checking this depends on your internal workflow, if authors can do this or not.
  • Translate only after approval: depends on if you have translators and their workflow.
  • Todo: next two sections are under development
  • Early access
  • Use early access workflow:
  • Early access is required:
  • Custom label for the early access field:
  • Other options
  • Use display date:
• Share: (Everything is shared by default)
  • Unless required not to share, don't make any changes.
  • When publishing, set the canonical URL to the "owner" of the article. Set the Canonical site page to the website that is the original publishing location for the article.
  • Disable syndication: don't allow anyone to publish articles from other sources on the websites of this entity.
  • Disable sharing: don't share your articles with others.
    • Prevent individual sharing: blocks even sharing of individual articles. 
  • Disable translation of shared articles: if you don't want other people translating your articles, check this box.
• Article types: Recommend initially leaving this as it is. If you just need to use standard articles, then perhaps this can be turned off and simplify the articles interface.

Web Module

• Setup the website to display articles from the Articles module.
• Expand the Web Module:
• Click on the name of the website.
• The website pagetree should appear to the right.
• Note: these instructions are for a basic setup of an article list and detail page on the website. In some cases, such as ANN, there will be multiple list and detail pages. These will need to be reviewed and setup as per the planned design of the website.

Articles list page

• If there is no article list view page. Create a new page at the proper level for your website design.
• When the page is created, the page preset screen should appear. 
• Look for a page preset implementing the Article List view, for your design.
• Click on the Page preset option, to select that option for the page.
• Click on the page title to view the page content.

Articles details page

• If there is no articles detail view page. Create a new subpage below the Articles list view page just created.
• When the page is created, the page preset screen should appear. 
• Look for a page preset implementing the Article Detail view, for your design.
• Click on the articles detail page to set that page as the articles detail view.
• Click on the page title to view the page content.

Article detail page settings

1. Locate the article detail page and open the page settings.

Advanced tab:

1. Click on the "Advanced" tab.
2. Navigate to the "Dynamic content" area
3. Checkbox "Has a dynamic url": Set checkmark
4. Resource field : "Article"
5. Click on Update button to save changes

General tab:

<note!> : To the right of some fields, there should be an icon ("{}").

1. Click on the General tab
2. Cut the existing Title, paste it into the Name field.
3. In the page Title field, click on the icon ("{}") to the right end of the field. In the icon menu, click on the Title option. The article variable for the Title should appear in the field.
4. In the Description field, click on the icon and select "Abstract". The system variable for Abstract should appear in the field.
5. ToDo: There is a bug, if you see "undefined{Article.abstract}" remove the text, so only {Article.abstract} is in the field. This is a known bug.
6. Put a checkmark in the "Hide in Menus" checkbox.  (a detail view should only be accessed by clicking on an item from the parent list page. No one should directly navigate to a detail page from a menu. Directly navigating to the page will throw an error)
7. Save the changes

SEO tab

1. Click on the SEO tab
2. Keywords: Click on the icon ("{}") and click on option "Tags".  Click on "Update" button.
3. Open Graph: most fields should be filled in, if the General(tab) configuration was done. If not, use the icon menu to apply the correct variables in the fields.
4. Image: Add the image using the system variable
5. Type: Set to "Article"
6. Save the changes

Article list page settings

1. Once the Article Detail page is configured, the articles list page block needs to be configured
2. Locate the Article list page and click on the title to edit the page content
3. On the page, locate any article block
4. Go to Properties tab for the block
5. Set article detail page for the block, to the detail page just created above.
6. Verify that if there is a mix of article list blocks, with different requirements/focuses, that they are mapped to the correct article detail page.
7. Save changes

Conclusion

At this point the Articles module should be setup. When articles are published to the website they should appear in the list and when the user clicks on the article in the list view, they should be taken to the detail view. If there are any issues, please check the languages, flags and any filtering that may be setup on the website.