{"id":105,"date":"2018-01-18T21:32:43","date_gmt":"2018-01-18T21:32:43","guid":{"rendered":"https:\/\/polyhedronsolutions.com\/?page_id=105"},"modified":"2018-03-01T20:50:55","modified_gmt":"2018-03-01T20:50:55","slug":"hyperkwic","status":"publish","type":"page","link":"https:\/\/polyhedronsolutions.com\/hyperkwic\/","title":{"rendered":"Software Documentation using HyperKWIC"},"content":{"rendered":"

HyperKWIC generates software documentation that combines the instant\u00a0connectivity of\u00a0hyper<\/strong><\/em>text with\u00a0the analytical strengths of\u00a0K<\/strong><\/em>eyW<\/strong><\/em>ord\u00a0I<\/strong><\/em>n\u00a0C<\/strong><\/em>ontext. \u00a0It\u00a0produces HTML documents that provide a fully interactive alternative to traditional documentation.<\/p>\n

\"HyperKWIC<\/a><\/p>\n

You can\u00a0interact with sample HyperKWIC reports for large Fortran and C programs by clicking here<\/span><\/a>\u00a0and\u00a0here<\/span><\/a><\/strong>.<\/p>\n

HyperKWIC is available free of charge<\/span><\/em> for not-for-profit, non-government use – and for evaluation by commercial users.\u00a0 \u00a0A commercial licence is required to modify the licence information displayed at the foot of each report page. HyperKWIC\u00a0is also included in the plusFORT<\/a> toolkit.<\/p>\n

Download HyperKWIC for Windows, Linux or Mac by clicking\u00a0here<\/span><\/a>.<\/strong><\/p>\n

Project Managers<\/strong><\/h3>\n
    \n
  • Meet requirements for accurate and complete software documentation with the aid of HyperKWIC reports which are generated automatically and quickly.<\/li>\n
  • Update as often as required, and\u00a0publish to your team and to other stakeholders.\u00a0 HyperKWIC reports may be stored\u00a0\u00a0locally or published on an internal or external website.<\/li>\n
  • Impact Analysis:\u00a0Even small changes to an established code base can have consequences that propagate through the entire program.\u00a0 With HyperKWIC you can quickly assess possible changes and produce a plan to minimize\u00a0coding effort.<\/li>\n<\/ul>\n

    Programmers<\/strong><\/h3>\n
      \n
    • Keep HyperKWIC software documentation open in your web browser for an instant answer to those constant questions:-\n
        \n
      • where is that defined?<\/li>\n
      • which routine set that value?<\/li>\n
      • what else uses that?<\/li>\n
      • is that redundant?<\/li>\n<\/ul>\n<\/li>\n
      • HyperKWIC\u00a0is aware of programming language syntax, including\u00a0comments and reserved words.\u00a0 Syntax rules for several common languages are defined in an external file, which may be customized as required.<\/li>\n
      • Right-click to\u00a0open a separate tab for reports you will need again later.<\/li>\n<\/ul>\n

        \"\"<\/p>\n","protected":false},"excerpt":{"rendered":"

        HyperKWIC generates software documentation that combines the instant\u00a0connectivity of\u00a0hypertext with\u00a0the analytical strengths of\u00a0KeyWord\u00a0In\u00a0Context. \u00a0It\u00a0produces HTML documents that provide a fully interactive alternative to traditional documentation. You can\u00a0interact with sample HyperKWIC reports for large Fortran and C programs by clicking here\u00a0and\u00a0here. HyperKWIC is available free of charge for not-for-profit, non-government use – and for evaluation by […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/polyhedronsolutions.com\/wp-json\/wp\/v2\/pages\/105"}],"collection":[{"href":"https:\/\/polyhedronsolutions.com\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/polyhedronsolutions.com\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/polyhedronsolutions.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/polyhedronsolutions.com\/wp-json\/wp\/v2\/comments?post=105"}],"version-history":[{"count":17,"href":"https:\/\/polyhedronsolutions.com\/wp-json\/wp\/v2\/pages\/105\/revisions"}],"predecessor-version":[{"id":787,"href":"https:\/\/polyhedronsolutions.com\/wp-json\/wp\/v2\/pages\/105\/revisions\/787"}],"wp:attachment":[{"href":"https:\/\/polyhedronsolutions.com\/wp-json\/wp\/v2\/media?parent=105"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}