• Replies 5 replies
  • Subscribers 137 subscribers
  • Views 1073 views
  • Users 0 members are here
Options
Related

Examples of in-product (web application) documents created with Tridion Documents?

Ryan Shubert

Hello,

We are looking to make our documentation content available through our web-applications rather than in PDFs or external HTML pages. Ideally the customer/reader using a web-application will be able to see relevant/featured content directly in the application without being redirected to external HTML sites (or PDFs). I'm interested to know about how others are doing this with Tridion Docs and if examples of solutions are available that can be shared. We plan to continue single-sourcing our content and will continue to deliver stand alone PDF  files and HTML to our existing support/documentation portals but we want the added ability of customers to locate content in-app as well.

Thanks!
emoji
Rate translation
×
Suggest better translation
×
Parents

  • I'm not sure this is 100% what you are looking for, but I'll send it just in case. We have this write up on how to create Context-Sensitive Help (to link to the appropriate Help topic from inside the app):

    Adding Context-sensitive Help
    There are two steps involved in adding context-sensitive Help in a product using a SuiteHelp Help system.

    1 Add one resource ID to each DITA topic that is identified for context-sensitive help.
    The resource ID values should be in uppercase.
    For each topic assigned to a page, window, or other UI element in your application, add a resource ID to the <prolog> element by placing your insertion point just before the </prolog> end tag and inserting a <resourceid> element. In the <id> attribute of the <resourceid/>, enter the value in uppercase letters. For example: MYRESOURCEID.
    -Tip: For concept, reference, and task topics, the <prolog> element comes after the <abstract> element and before the <conbody>, <refbody>, and <taskbody> elements, respectively. However, for the glossary topic (<glossentry> element), the <prolog> element comes after the </glossdef> end tag and before the </glossentry> end tag.


    2 Provide the product developers with the list of resource IDs.
    They will use them in the appropriate areas of the product’s user interface to link to the specific topics. The links are created by appending the resource ID as a context parameter to the Help URL.
    emoji
Reply

  • I'm not sure this is 100% what you are looking for, but I'll send it just in case. We have this write up on how to create Context-Sensitive Help (to link to the appropriate Help topic from inside the app):

    Adding Context-sensitive Help
    There are two steps involved in adding context-sensitive Help in a product using a SuiteHelp Help system.

    1 Add one resource ID to each DITA topic that is identified for context-sensitive help.
    The resource ID values should be in uppercase.
    For each topic assigned to a page, window, or other UI element in your application, add a resource ID to the <prolog> element by placing your insertion point just before the </prolog> end tag and inserting a <resourceid> element. In the <id> attribute of the <resourceid/>, enter the value in uppercase letters. For example: MYRESOURCEID.
    -Tip: For concept, reference, and task topics, the <prolog> element comes after the <abstract> element and before the <conbody>, <refbody>, and <taskbody> elements, respectively. However, for the glossary topic (<glossentry> element), the <prolog> element comes after the </glossdef> end tag and before the </glossentry> end tag.


    2 Provide the product developers with the list of resource IDs.
    They will use them in the appropriate areas of the product’s user interface to link to the specific topics. The links are created by appending the resource ID as a context parameter to the Help URL.
    emoji
Children