Skip to main content
pdf?stylesheet=default
Blackboard Help

Customize the Help Experience

Within a Language Pack, you can change any of the default links to Blackboard Help. To change the target of these links, edit the links in the documentation.properties file.

These links can be changed to point to other versions of Blackboard Help, including versions for older service packs or versions that you have created, or to other resources such as an institution support web site. To learn more about the availability of help content in other formats, see About Help.

Working with Language Packs

By default, Help links in Blackboard Learn point to various sections of Blackboard Help in the version appropriate for your site and in the language associated with your Learn language pack. Learn automatically appends each link with language-locale code of your site or the user's selected language pack.

If you are using a language pack, Learn automatically appends each link with your custom language pack's language-locale code, and in most cases, those links will not be valid.

For example:

If your custom language pack is "es-co" and you want to link to the Blackboard Help site in Spanish, you would change @X@user.locale@X@ to es_ES:

https://redirects.blackboard.com/001_000@X@user.locale@X@
becomes
https://redirects.blackboard.com/001_000es_US

Upgrading Blackboard Learn or just the Language Pack can result in broken links to the documentation resources. To learn more, see Maintain Language Packs.

How to Edit the Documentation Links in a Language Pack

The following procedure details how to edit the links using the Language Pack Editor. These links may also be edited by using a text editor.

  1. On the Administrator Panel, under Tools and Utilities, click Language Packs.
  2. Select Edit from the contextual menu for a Language Pack that can be edited.
  3. Scroll down to accept the terms and click Submit.
  4. Search for the documentation.properties file and select Edit from the contextual menu.
  5. Edit the field URLs as appropriate.
    Documentation Properties
    Field Description
    documentation.href.help_home The link to the main landing page of Blackboard Help.
    documentation.href.online_admin The link for the Blackboard Help text on the Administrator Panel under Help. By default this text links to the administrator section of Blackboard Help.
    documentation.href.cp_online_manual The link for the Blackboard Help text on the Control Panel for each course under Help. By default this text links to the instructor section of Blackboard Help.
    documentation.href.student_manual The link for the Blackboard Help text on the Tools page in any course page. By default this text links to the student section of Blackboard Help.
    documentation.href.cs_manual The link for the Help text on the Content Collection tab available after clicking Tools. By default this text links to the content management user section of Blackboard Help.
    documentation.href.online_outcomes The link to Outcomes Help under Learn on the Outcomes tab available after clicking Discover. By default this links to the outcomes assessment section on Blackboard Help.
    documentation.href.label online_outcomes The label for the link to Outcomes Help under Learn on the Outcomes tab available after clicking Discover. By default, this text is "Outcomes Help."
    documentation.href.sis_help_key The link for the Student Integration Services Planning Documentation text on the Data Integration > Student Information System Integrations > Sample Documents page. By default this text links to the Planning SIS Integrations topic in Blackboard Help.
    documentation.href.help|video_... The links for help topics and videos that appear in the Sample Content included with the various Course Structures provided by Blackboard for creating courses.
    documentation.href.ultra_ui_doc Available for SaaS deployments only: The link to Blackboard Administrator Help for the Blackboard Learn SaaS deployment.
    documentation.href.ultra_ui_release_note Available for SaaS deployments only: The link to the Release Notes for the Blackboard Learn SaaS deployment.
    bb.collaborate... The links for help topics that appear in the Blackboard Collaborate Launcher.
    documentation.href.saml.page.instructions The link for the More Help text on the Administrator Panel > Authentication > SAML Authentication Settings page. By default this text links to the SAML Authentication Provider Type topic in Blackboard Help.
    documentation.href.help.index The link for the Blackboard Help site on the login page. By default this link points to the Blackboard Help site in English because Learn cannot determine the user's language pack before the user has logged in.
  6. Click Submit.