From 8cf3719a8289bcf880d921d36447894e8e2b0664 Mon Sep 17 00:00:00 2001 From: Peter LaFosse Date: Mon, 26 Nov 2018 21:31:46 -0500 Subject: Update documentation for show_markdown_report and show_html_report --- python/interaction.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'python') diff --git a/python/interaction.py b/python/interaction.py index 1a4d37d5..abb21538 100644 --- a/python/interaction.py +++ b/python/interaction.py @@ -643,7 +643,8 @@ def show_plain_text_report(title, contents): def show_markdown_report(title, contents, plaintext=""): """ ``show_markdown_report`` displays the markdown contents in UI applications and plaintext in command line - applications. + applications. Markdown reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows: + ``binaryninja://?expr='_start'`` Where ``expr=`` specifies an expression parsable by the `parse_expression` api. Note: This API function differently on the command line vs. the UI. In the UI a popup is used. On the commandline a simple text prompt is used. @@ -661,7 +662,8 @@ def show_markdown_report(title, contents, plaintext=""): def show_html_report(title, contents, plaintext=""): """ ``show_html_report`` displays the html contents in UI applications and plaintext in command line - applications. + applications. HTML reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows: + ``binaryninja://?expr='_start'`` Where ``expr=`` specifies an expression parsable by the `parse_expression` api. Note: This API function differently on the command line vs. the UI. In the UI a popup is used. On the commandline a simple text prompt is used. -- cgit v1.3.1