Skip to content

Create Nicer HTML with search using the oxygen webhelp templat.  #2490

@billy-the-fish

Description

@billy-the-fish

Business case - fastest solution to have the same output as the current release
Fix version -
Subject Matter Expert - Iain
Reviewer - Emily
Scope - All ditamaps in https://github.com/AgoraIO/agora_doc_source/tree/master/en-US/dita/RTC-NG. You need to:

  1. Make a branch from milestone-1-update-the-dita-build.

  2. In Oxygen, open /agora_doc_source/en-US/dita/RTC-NG/RTC_NG_API_Android.ditamap.

  3. Choose the Agora Webhelp transformation.
    Screenshot 2022-10-18 at 15 45 22

  4. Run the configuration and check the output works ok.
    It should look like:
    Screenshot 2022-10-18 at 16 09 45

  5. Use CSS to update the colors etc to match Agora branding.
    https://www.oxygenxml.com/doc/versions/25.0/ug-editor/topics/webhelp-customizing-with-css.html?hl=css%2Cfile.

  6. Update the breadcrumb root to say Video SDK for Android instead of Android API Reference

  7. Sort out the top nav, get rid of the big blue box, make the search bar a normal size, put the index terms icon next to the search. Best to ask Malavika about hhow it shourld really look

  8. Save the project, build and check your changes.

  9. Make a PR to the milestone branch and ask Iain to validate.

  10. Soon as this works, do the same thing for all other ditamaps.
    Estimated -
    Acceptance criteria - HTML output approve Agora look and feel. File names do not change.
    Additional valuable information:

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions