Documentation of variables available in templates

[despens]

Need a list of variables available in the jinja2 templates.

[ikreymer]

Track docs work in #289

[N0taN3rd]

Noting vars available in templates as of pwyb@develop:adf34cdb3569ac3f5999cb8b07ff98f8ede168c1 for future documentation work

TopFrameView.get_top_frame:
{'coll': '',
 'embed_url': 'mp_/http://example.com/',
 'env': {'GATEWAY_INTERFACE': 'CGI/1.1',
         'HTTP_ACCEPT': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8',
         'HTTP_ACCEPT_ENCODING': 'gzip, deflate, br',
         'HTTP_ACCEPT_LANGUAGE': 'en-US,en;q=0.9',
         'HTTP_CACHE_CONTROL': 'max-age=0',
         'HTTP_CONNECTION': 'keep-alive',
         'HTTP_COOKIE': '_ga=GA1.1.279659629.1536608812',
         'HTTP_HOST': 'localhost:8080',
         'HTTP_SEC_METADATA': 'cause="forced", destination="document", '
                              'target="top-level", site="cross-site"',
         'HTTP_UPGRADE_INSECURE_REQUESTS': '1',
         'HTTP_USER_AGENT': 'Mozilla/5.0 (X11; Linux x86_64) '
                            'AppleWebKit/537.36 (KHTML, like Gecko) '
                            'Chrome/69.0.3497.92 Safari/537.36',
         'PATH_INFO': '/http://example.com/',
         'QUERY_STRING': '',
         'REMOTE_ADDR': '127.0.0.1',
         'REMOTE_PORT': '56818',
         'REQUEST_METHOD': 'GET',
         'REQUEST_URI': '/live/http://example.com/',
         'SCRIPT_NAME': '/live',
         'SERVER_NAME': 'cynic',
         'SERVER_PORT': '8080',
         'SERVER_PROTOCOL': 'HTTP/1.1',
         'SERVER_SOFTWARE': 'gevent/1.3 Python/3.6',
         'pywb.app_prefix': '',
         'pywb.templates_dir': 'collections/live/templates',
         'wsgi.errors': <_io.TextIOWrapper name='<stderr>' mode='w' encoding='UTF-8'>,
         'wsgi.input': <gevent.pywsgi.Input object at 0x7f36ac84cc48>,
         'wsgi.multiprocess': False,
         'wsgi.multithread': False,
         'wsgi.run_once': False,
         'wsgi.url_scheme': 'http',
         'wsgi.version': (1, 0)},
 'host_prefix': 'http://localhost:8080',
 'is_proxy': False,
 'options': {'frame_mod': '', 'replay_mod': 'mp_'},
 'static_prefix': '/static',
 'timestamp': '20180913191847',
 'url': 'http://example.com/',
 'wb_prefix': 'http://localhost:8080/live/',
 'wb_url': ('latest_replay', '', '', 'http://example.com/', 'http://example.com/')}
---------------------
HeadInsertView.create_insert_func -> make_head_insert
{'cdx': CDXObject([('urlkey', 'com,example)/'),
                   ('timestamp', '20180913191847'),
                   ('url', 'http://example.com/'),
                   ('load_url', 'http://example.com/'),
                   ('is_live', 'true'),
                   ('mime', ''),
                   ('source', 'live'),
                   ('source-coll', 'live')]),
 'coll': 'live',
 'config': {'archive_paths': 'archive',
            'banner_html': 'banner.html',
            'collections': {'all': '$all',
                            'live': '$live',
                            'pywb': {'archive_paths': './sample_archive/warcs/',
                                     'index_paths': './sample_archive/cdx/'}},
            'collections_root': 'collections',
            'debug': True,
            'enable_memento': True,
            'error_html': 'error.html',
            'frame_insert_html': 'frame_insert.html',
            'framed_replay': True,
            'head_insert_html': 'head_insert.html',
            'home_html': 'index.html',
            'html_templates': ['banner_html',
                               'head_insert_html',
                               'frame_insert_html',
                               'query_html',
                               'search_html',
                               'not_found_html',
                               'home_html',
                               'error_html',
                               'proxy_cert_download_html',
                               'proxy_select_html'],
            'index_paths': 'indexes',
            'info_json': 'collinfo.json',
            'not_found_html': 'not_found.html',
            'proxy': {'ca_file_cache': 'proxy-certs/pywb-ca.pem',
                      'ca_name': 'pywb HTTPS Proxy CA',
                      'coll': 'live',
                      'recording': False,
                      'use_preserve_worker': True,
                      'use_wombat': False},
            'proxy_cert_download_html': 'proxy_cert_download.html',
            'proxy_select_html': 'proxy_select.html',
            'query_html': 'query.html',
            'rules_config': 'pkg://pywb/rules.yaml',
            'search_html': 'search.html',
            'static_path': 'static',
            'templates_dir': 'templates',
            'use_js_obj_proxy': True},
 'env': {'GATEWAY_INTERFACE': 'CGI/1.1',
         'HTTP_ACCEPT': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8',
         'HTTP_ACCEPT_ENCODING': 'gzip, deflate, br',
         'HTTP_ACCEPT_LANGUAGE': 'en-US,en;q=0.9',
         'HTTP_CONNECTION': 'keep-alive',
         'HTTP_COOKIE': '_ga=GA1.1.279659629.1536608812',
         'HTTP_HOST': 'localhost:8080',
         'HTTP_REFERER': 'http://example.com/',
         'HTTP_SEC_METADATA': 'cause="forced", destination="document", '
                              'target="nested", site="same-origin"',
         'HTTP_UPGRADE_INSECURE_REQUESTS': '1',
         'HTTP_USER_AGENT': 'Mozilla/5.0 (X11; Linux x86_64) '
                            'AppleWebKit/537.36 (KHTML, like Gecko) '
                            'Chrome/69.0.3497.92 Safari/537.36',
         'PATH_INFO': '/mp_/http://example.com/',
         'QUERY_STRING': '',
         'REMOTE_ADDR': '127.0.0.1',
         'REMOTE_PORT': '56818',
         'REQUEST_METHOD': 'GET',
         'REQUEST_URI': '/live/mp_/http://example.com/',
         'SCRIPT_NAME': '/live',
         'SERVER_NAME': 'cynic',
         'SERVER_PORT': '8080',
         'SERVER_PROTOCOL': 'HTTP/1.1',
         'SERVER_SOFTWARE': 'gevent/1.3 Python/3.6',
         'pywb.app_prefix': '',
         'pywb.host_prefix': 'http://localhost:8080',
         'pywb.templates_dir': 'collections/live/templates',
         'wsgi.errors': <_io.TextIOWrapper name='<stderr>' mode='w' encoding='UTF-8'>,
         'wsgi.input': <gevent.pywsgi.Input object at 0x7f36abd06d68>,
         'wsgi.multiprocess': False,
         'wsgi.multithread': False,
         'wsgi.run_once': False,
         'wsgi.url_scheme': 'http',
         'wsgi.version': (1, 0)},
 'host_prefix': 'http://localhost:8080',
 'is_framed': 'true',
 'is_live': 'true',
 'replay_mod': 'mp_',
 'static_prefix': 'http://localhost:8080/static',
 'top_url': 'http://localhost:8080/live/http://example.com/',
 'wb_prefix': 'http://localhost:8080/live/',
 'wb_url': ('latest_replay', '', 'mp_', 'http://example.com/', 'mp_/http://example.com/'),
 'wombat_mode': 'p',
 'wombat_sec': 1536866327,
 'wombat_ts': '20180913191847'}