ui5-language-assistant icon indicating copy to clipboard operation
ui5-language-assistant copied to clipboard

Support more html tags in documentation

Open tal-sapan opened this issue 4 years ago • 1 comments

Some missing tags/special cases are:

<p>
<ol> - use 1. for ordered list items
<a href=...> - make a link for http(s), remove link for others
<a>, <a name ...> - should be removed
<table>, <tr>, <td>, <th>, <tt>
<u>
<B>, <Li>, <br >, <table border="1"> - we should probably ignore the case, white space and additional properties in all tags
<caption>
<svg> - we should probably remove it and add a note that says the image can be viewed in the "More Information" link

Additionally we should add a test that checks all tags are covered in the versions we support (with a whitelist for tags we shouldn't support even though they appear in the documentation, because they are not really tags - <int>, <Note:> etc)

tal-sapan avatar Jul 20 '20 13:07 tal-sapan

Documentation related utils can be found here:

  • https://github.com/SAP/ui5-language-assistant/blob/master/packages/logic-utils/src/utils/documentation.ts

Tests can be found here:

  • https://github.com/SAP/ui5-language-assistant/blob/master/packages/logic-utils/test/utils/documentation-spec.ts

bd82 avatar Jul 20 '20 14:07 bd82