Individual document

This page describes the individual document pages used in the Digital Library.

Individual document pages are stored as NationBuilder blog post pages - within the Digital Library blog.

These posts are created by users via the Share a document page.

There is a special blog post template used for Document posts to display all their extra details.

If the logged in user is the author - they will see the "Edit Cog" in the top right corner - from here they can Edit or Delete their document. Please see the "Edit Menu" section below for more information.

#Individual Document blog post page

Document Header

The first section of the page will contain details about the document:

Document Summary

This second section is the summary - the main body text giving context to the document files.

Downloads

The third section is the Downloads grid. Each attached file uploaded will be rendered as a card in a card grid here.
Each card will contain:

Privacy Notes

At the bottom of the page - depending on if the submitted document author selected - Admins will find one of the following notes:

Attention: User has given permission to re-use these images.
or
Attention: Do not share these images! User has NOT given permission to re-use these images.

If the document is private group document and the user is able to view - they will see the following note:

Attention: This is a private group document. If you share this URL with anyone they will need to join Landcare Tasmania and become a group member to access the document.

Private Group Document card

Private Group Documents will not render in the Digital Library card grid. They will only render on the Group's profile.

If a user is viewing a group profile which has a Private Group document and they aren't a member of the group - they will see the card render will lower opacity and a “Private 🔒” label in the top right corner.
If user clicks on the locked card they will be shown a modal:

Private Document
This document restricted to GROUP_NAME members.

The message will also contain details/explanation for why they cannot see it.

If user is not sorta_logged_in:

If you are a member of GROUP_NAME - login to view.
[“Login” button - /login]

If user is sorta_logged_in - not a member, not connected:

You can request member access by connecting to the GROUP_NAME group.

If user is sorta_logged_in - not a member, but is connected:

Your member request is pending - you will receive an email once approved.

Edit Menu (⚙ Cog + Dropdown)

If the user is the author of the document post, or if the document is a group post and they are an editor for that group, then an "Edit Cog Icon ⚙" is shown in the top right corner on the the post page.

Clicking the Cog Icon ⚙ will show a drop down menu with two menu items:

Document Fields and Tags

The following details the fields and tags the document information is stored in a blog post

Headline Field

The blog post headline stores the document entry title/headline.

Content Field

The blog post "content before flip" is used to store the document summary text.

Status Field

The blog post status can be:

author:ID Tag

This tag contains the submitter's user ID. It does not impact the frontend at all but allows admin users to filter by posted shared by that user in the backend easily.

doc_author:Name Tag

If this tag is present it will override the submitter's name with the name stored in the tag.

doc_date:YYYY-MM-DD Tag

If this tag is present it will override the publish date on the post. This is useful if the submitted document is a historical document.

doc_org:ORG_ID Tag

If the document was created for an organisation then it will have this tag, where ORG_ID is the related organisation ID. These documents will appear on the organisation profile page.

doc_permission_to_share Tag

The user has indicated that the files can be shared by Landcare Tas. This tag controls a note added to the bottom of the post - near by Social Share buttons. Only NB admins will see these messages.

If post has this tag:

ADMINS: User has given permission for Landcare Tasmania to use images.

If post does not have this tag - in red:

ADMINS: Do not share these images externally! User has NOT given permission for Landcare Tasmania to use images.

doc_public Tag

This document is public and will be shown to all users in the main digital library page.

All non-organisation documents will be public.

doc_private Tag

This document is private for organisation members only. The document will not show in the main digital archive page.

Note that only organisation documents with the doc_org:ORG_ID tag can be private.

The document will only show on the organisation profile page if the user is signed in and is a member of that organsation.

If the post has this tag - we will display the following message at the bottom of the post - near the Social Share buttons:

NOTE: Ths is a private group document. If you share this URL with anyone they will need to join Landcare Tasmania and become a group member to access the document.

doc_url:URL Tags

Uploaded file attachments are stored in a third party service called Cloudinary.

Uploaded files will be linked to the Document post using page tags in the format doc_url:URL where URL is the Cloudinary file URL.

Note: Cloudinary adds an seven random characters (for example _jr6gdb) to the filename to ensure the file names are unique - this is removed before displaying the file name to the end user.

Example:

filter:Type:TYPE Tags

Tags that start with filter: are used to filter documents. The user can select toggles to filter document posts by category.

Tags in the formal filter:Type:TYPE are for filtering by Document Type.

Current options for TYPE:

filter:Topic:TOPIC Tags

Tags that start with filter: are used to filter documents. The user can select toggles to filter document posts by category.

Tags in the formal filter:Topic:TOPIC are for filtering by Landcare Tasmania topics.

Current options for TOPIC: