Document data available to HTML templates

[pombredanne]

We need to document the data available to a Jinja custom template
See #789 (comment)

@Shaker1978 good point ... there is little or no doc for that. The only "doc" would be the example default HTML output template at https://github.com/nexB/scancode-toolkit/blob/bec80ec900a69285ea4e545dc0755061243a5638/src/formattedcode/templates/html/template.html and the code that renders the Jinja template at https://github.com/nexB/scancode-toolkit/blob/bec80ec900a69285ea4e545dc0755061243a5638/src/formattedcode/output_html.py#L165

[championpaddler]

@pombredanne Claiming this Sir .

[championpaddler]

@pombredanne Can you explain more about this issue??

[pombredanne]

@sk9331657 the thing is that you can output a scan to html and that you can use a custom template for this. The default template is this: https://github.com/nexB/scancode-toolkit/blob/63015c44178abc98ae4d1bd9f0a6dd398edfa581/src/formattedcode/templates/html/template.html
and it is fed some data that are these https://github.com/nexB/scancode-toolkit/blob/63015c44178abc98ae4d1bd9f0a6dd398edfa581/src/formattedcode/output_html.py#L165

The issue is that there is no documentation about what data can be used in the template

[championpaddler]

@sk9331657 the thing is that you can output a scan to html and that you can use a custom template for this. The default template is this: https://github.com/nexB/scancode-toolkit/blob/63015c44178abc98ae4d1bd9f0a6dd398edfa581/src/formattedcode/templates/html/template.html
and it is fed some data that are these

https://github.com/nexB/scancode-toolkit/blob/63015c44178abc98ae4d1bd9f0a6dd398edfa581/src/formattedcode/output_html.py#L165

The issue is that there is no documentation about what data can be used in the template

Thanks for clarification .

[championpaddler]

@pombredanne It is better to document parameter directly in Html. What are ur reviews??

[sritasngh]

@pombredanne Out of license, copyright, email, url and package (default) scan results, only license, copyright and package I can get by this template https://github.com/nexB/scancode-toolkit/blob/develop/src/formattedcode/templates/html/template.html . https://github.com/nexB/scancode-toolkit/blob/63015c44178abc98ae4d1bd9f0a6dd398edfa581/src/formattedcode/output_html.py#L234-L238 Also only these data have been fed here. So how can we get email and url? Do we need to add email and url like this?

[pombredanne]

@itssingh yes, exactly 👍

[sritasngh]

exactly

All right, I'll open a pr for email and url :)