{"id":18869,"date":"2017-10-25T18:13:39","date_gmt":"2017-10-25T17:13:39","guid":{"rendered":"https:\/\/fortran.uk\/?page_id=18869"},"modified":"2018-01-18T18:39:27","modified_gmt":"2018-01-18T18:39:27","slug":"hyperkwic","status":"publish","type":"page","link":"https:\/\/fortran.uk\/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 is a part of the plusFORT toolkit.\u00a0 It is also available as a separate download (free for not-for-profit, non-government use – including evaluation).<\/p>\n


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


\nYou can\u00a0interact with sample HyperKWIC reports for large Fortran and C programs by clicking here<\/span><\/a>\u00a0and\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
      • R-click to\u00a0open a separate tab for reports you will need again later.<\/li>\n<\/ul>\n

         <\/p>\n

         <\/p>\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. HyperKWIC is a part of the plusFORT toolkit.\u00a0 It is also available as a separate download (free for not-for-profit, non-government use – including evaluation). You can\u00a0interact with sample HyperKWIC reports […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"yoast_head":"\nSoftware Documentation using HyperKWIC - Fortran UK<\/title>\n<meta name=\"description\" content=\"HyperKWIC generates software documentation that combines the instant connectivity of hypertext with the analytical strengths of KeyWord In Context.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/fortran.uk\/hyperkwic\/\" \/>\n<meta property=\"og:locale\" content=\"en_GB\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Software Documentation using HyperKWIC - Fortran UK\" \/>\n<meta property=\"og:description\" content=\"HyperKWIC generates software documentation that combines the instant connectivity of hypertext with the analytical strengths of KeyWord In Context.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/fortran.uk\/hyperkwic\/\" \/>\n<meta property=\"og:site_name\" content=\"Fortran UK\" \/>\n<meta property=\"article:modified_time\" content=\"2018-01-18T18:39:27+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/fortran.uk\/wp-content\/uploads\/2017\/10\/HK-3.png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Estimated reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/fortran.uk\/hyperkwic\/\",\"url\":\"https:\/\/fortran.uk\/hyperkwic\/\",\"name\":\"Software Documentation using HyperKWIC - Fortran UK\",\"isPartOf\":{\"@id\":\"https:\/\/fortran.uk\/#website\"},\"datePublished\":\"2017-10-25T17:13:39+00:00\",\"dateModified\":\"2018-01-18T18:39:27+00:00\",\"description\":\"HyperKWIC generates software documentation that combines the instant connectivity of hypertext with the analytical strengths of KeyWord In Context.\",\"breadcrumb\":{\"@id\":\"https:\/\/fortran.uk\/hyperkwic\/#breadcrumb\"},\"inLanguage\":\"en-GB\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/fortran.uk\/hyperkwic\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/fortran.uk\/hyperkwic\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/fortran.uk\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Software Documentation using HyperKWIC\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/fortran.uk\/#website\",\"url\":\"https:\/\/fortran.uk\/\",\"name\":\"Fortran UK\",\"description\":\"All things Fortran\",\"publisher\":{\"@id\":\"https:\/\/fortran.uk\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/fortran.uk\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-GB\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/fortran.uk\/#organization\",\"name\":\"Polyhedron Solutions Ltd.\",\"url\":\"https:\/\/fortran.uk\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-GB\",\"@id\":\"https:\/\/fortran.uk\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/fortran.uk\/wp-content\/uploads\/2018\/03\/Web-logoPolySol.png\",\"contentUrl\":\"https:\/\/fortran.uk\/wp-content\/uploads\/2018\/03\/Web-logoPolySol.png\",\"width\":203,\"height\":113,\"caption\":\"Polyhedron Solutions Ltd.\"},\"image\":{\"@id\":\"https:\/\/fortran.uk\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.youtube.com\/@polyhedronsolutions1405\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Software Documentation using HyperKWIC - Fortran UK","description":"HyperKWIC generates software documentation that combines the instant connectivity of hypertext with the analytical strengths of KeyWord In Context.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/fortran.uk\/hyperkwic\/","og_locale":"en_GB","og_type":"article","og_title":"Software Documentation using HyperKWIC - Fortran UK","og_description":"HyperKWIC generates software documentation that combines the instant connectivity of hypertext with the analytical strengths of KeyWord In Context.","og_url":"https:\/\/fortran.uk\/hyperkwic\/","og_site_name":"Fortran UK","article_modified_time":"2018-01-18T18:39:27+00:00","og_image":[{"url":"https:\/\/fortran.uk\/wp-content\/uploads\/2017\/10\/HK-3.png"}],"twitter_card":"summary_large_image","twitter_misc":{"Estimated reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/fortran.uk\/hyperkwic\/","url":"https:\/\/fortran.uk\/hyperkwic\/","name":"Software Documentation using HyperKWIC - Fortran UK","isPartOf":{"@id":"https:\/\/fortran.uk\/#website"},"datePublished":"2017-10-25T17:13:39+00:00","dateModified":"2018-01-18T18:39:27+00:00","description":"HyperKWIC generates software documentation that combines the instant connectivity of hypertext with the analytical strengths of KeyWord In Context.","breadcrumb":{"@id":"https:\/\/fortran.uk\/hyperkwic\/#breadcrumb"},"inLanguage":"en-GB","potentialAction":[{"@type":"ReadAction","target":["https:\/\/fortran.uk\/hyperkwic\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/fortran.uk\/hyperkwic\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/fortran.uk\/"},{"@type":"ListItem","position":2,"name":"Software Documentation using HyperKWIC"}]},{"@type":"WebSite","@id":"https:\/\/fortran.uk\/#website","url":"https:\/\/fortran.uk\/","name":"Fortran UK","description":"All things Fortran","publisher":{"@id":"https:\/\/fortran.uk\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/fortran.uk\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-GB"},{"@type":"Organization","@id":"https:\/\/fortran.uk\/#organization","name":"Polyhedron Solutions Ltd.","url":"https:\/\/fortran.uk\/","logo":{"@type":"ImageObject","inLanguage":"en-GB","@id":"https:\/\/fortran.uk\/#\/schema\/logo\/image\/","url":"https:\/\/fortran.uk\/wp-content\/uploads\/2018\/03\/Web-logoPolySol.png","contentUrl":"https:\/\/fortran.uk\/wp-content\/uploads\/2018\/03\/Web-logoPolySol.png","width":203,"height":113,"caption":"Polyhedron Solutions Ltd."},"image":{"@id":"https:\/\/fortran.uk\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.youtube.com\/@polyhedronsolutions1405"]}]}},"_links":{"self":[{"href":"https:\/\/fortran.uk\/wp-json\/wp\/v2\/pages\/18869"}],"collection":[{"href":"https:\/\/fortran.uk\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/fortran.uk\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/fortran.uk\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/fortran.uk\/wp-json\/wp\/v2\/comments?post=18869"}],"version-history":[{"count":35,"href":"https:\/\/fortran.uk\/wp-json\/wp\/v2\/pages\/18869\/revisions"}],"predecessor-version":[{"id":18977,"href":"https:\/\/fortran.uk\/wp-json\/wp\/v2\/pages\/18869\/revisions\/18977"}],"wp:attachment":[{"href":"https:\/\/fortran.uk\/wp-json\/wp\/v2\/media?parent=18869"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}