Skip to content

Fix template error #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
steven-esser merged 2 commits into from
Oct 28, 2019
Merged

Fix template error #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40b81c5
Fix scancode command example
AyanSinhaMahapatra Oct 27, 2019
f2d6cc4
Fix template error
AyanSinhaMahapatra Oct 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions docs/source/scancode-toolkit/rst_snippets/custom_output_format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ data for this particular scan.

## template.html:
[
{% if results.license_copyright %}
{% for location, data in results.license_copyright.items() %}
{% if files.license_copyright %}
{% for location, data in files.license_copyright.items() %}
{% for row in data %}
location:"{{ location }}",
{% if row.what == 'copyright' %}copyright:"{{ row.value|escape }}",{% endif %}
Expand All @@ -36,12 +36,12 @@ Now I can run ScanCode using my newly created template:

::

$ ./scancode -clpeui --custom-output sample.json --custom-template sample.html samples
$ ./scancode -clpeui --custom-output output.json --custom-template template.html samples
Scanning files...
[####################################] 46
Scanning done.

Now are results are saved in ``t.json`` and we can easily view them with ``head t.json``\ :
Now are results are saved in ``output.json`` and we can easily view them with ``head output.json``:

::

Expand All @@ -53,8 +53,7 @@ Now are results are saved in ``t.json`` and we can easily view them with ``head
copyright:"copyrighted by the Free Software Foundation",
]

..
[ToDo]
There is an error in the template.html file:
"UndefinedError: 'results' is undefined"
Will be solved in a later commit.
For a more elaborate template, refer this `default template <https://github.com/nexB/scancode-toolkit/blob/develop/src/formattedcode/templates/html/template.html>`_
given with Scancode, to generate HTML output with the ``--html`` output format option.

Documentation on `Jinja templates <https://jinja.palletsprojects.com/en/2.10.x/>`_.