Website editing guidelines

NOTE: These guidelines are in place during the development and review period for the website. Design and editing guidance changes will be guiding by a web management group which has yet to be established.

Home page
https://ddialliance.org

Editing page
https://app-eu1.hubspot.com/login/

HubSpot guides:

Getting started with HubSpot CMS tools
https://app-eu1.hubspot.com/academy/144531336/lessons/1054824/5082
Suggest:
How to Create a Page in Content Hub

Beginning

• Log in

• Select “content” on left-hand tools column then “Webpage”

  Open

  

General editing guidelines

• Avoid direct cut and paste except from a basic text file, this prevents inadvertently changing fonts or text size

• Use site tools to provide formatting (lists, links, inserting images, etc.)

• We are currently using the ONE_COLUMN_STARTER_PAGE as the standard template.

• Pages are split into the following groupings:

  • Product pages (product section plus resources, markup examples, tools, relationships to other standards, and getting started) – Wendy is editor

  • Administration and remaining pages under Learn – Jared is editor

  • Data base generated pages – managed by Daren and Oliver, updating content is handled by relevant editor

Modifying an existing page

• NOTE: we do not support a "last updated" notification on the page as this has been inconsistently used (editors can get this information from the page listing which is more reliable)

• Locate page you wish to edit (start typing name in search space)

• Modifying content Title, subtitle, content (add details)

• Modifying structure

  • (add details regarding lists, images, type of text, etc.)

  • (add guidelines regarding multi-column, or other differences)

  • Do not alter basics such as font type or overall size (size change be changed for differentiation from other text)

Creating a new page

Locate: ONE_COLUMN_STARTER_PAGE

Open

• Hover over ONE_COLUMN_STARTER_PAGE

   

• Click on “Clone”

• Add new name for page and click on clone (this is the name that appears on the list and may be a shorted version of the page title)

• When new page template opens click on Settings to complete name changes

   

  • The name you entered will show in Internal page name

  • Provide an NCNAME for the page (this must be unique)

  • Click on edit symbol on the page URL to update the slug on URL to short meaningful NCNAME (note that we do not capture nesting here allowing for easy movement of content pages by redefining the nesting and listing under primary content columns)

Links

• Internal

  • These should be relative links using the link process and stub information

  • This pertains to both internal web pages and documents

    • Use “One of your pages” or “File” under Link to: as appropriate

• External

  • (use DOI for external documents when available, otherwise full URL)

Nesting of pages

On Web Pages listing select the drop-down menu “More Tools” and then “Advanced Menus”

Highlighting a row brings up the “Action” icon. Select the desired option such as “Add child item below”, “Add item below”, “Add link”, etc.

Attaching content to drop-down lists

Primary and secondary listings for menu headers

Note that the first column provides the label seen on the menu and the second is the link information. Currently, the menu header does not provide a link to the content page (an annotated list of initial child pages).

In most cases only the first level child pages are listed. Some large sections also show secondary child pages. General guidance on the extent of listings will be determined during initial review period.

Updating related content

• Addition or movement of some pages may require updating a summary page for a drop-down header as well as nesting information

• Publication of a new product version requires update to the product page

• Publication of a new product may require movement of content from the developing products page to the overview of current products page

• Other pages may have content that needs to be aligned over time and records should be kept on these relationships

Updating database content

(TBD add information on how to add new content or update existing content to various databases. This may include the use of entry forms)

News Items

News items are implemented using the Blog feature of Hubspot. The general editing and creation work in the same fashion, as for web pages. All blog posts (news items) will get listed in a shortened view within the News page being accessible through the main menu. Ordering is by the initial publication date. All news items will also have their own page display containing alle their content. In addition, the three most recent news will appear on the start page.

Creating and editing Blog posts is handled in a separate section of the hubspot backend. This section can be found in the side menu of the backend:

The backend main page for Blog posts contains a list of all entries, ordered by last update. Filtering and searching is possible like for standard web pages.

By clicking any listed post, it can be edited. The “Create” button offers the creation of a new entry. The main editing form is quite similar to the web page one:

Somehow special are the settings to be applied to a Blog post:

The Blog post require a title. The accociated Blog URL will be derived from that title initially and can get shortened by hand. It is also required to set the autor of the post. The selection list allready contains a list of previous authors.

Tags are not required for Bolg posts, but future filtering might be easier, if all new posts would have some tags associated.