|
| 1 | +--- |
| 2 | +layout: "programs-tplt" |
| 3 | +group: apps |
| 4 | +priority: 7.5 |
| 5 | +version: "0.1.0" |
| 6 | +os: "Windows 7 & later" |
| 7 | +release-date: "2023-07-12" |
| 8 | +title: "SWAGView" |
| 9 | +precis: "Basic viewer for the SWAG Pascal source code collection." |
| 10 | +summary: "Basic viewer application for the SWAG Pascal source code collection." |
| 11 | +meta-title: "SWAGView: SWAG snippet collection viewer | Open Source | 32/64 bit" |
| 12 | +meta-desc: "32 bit & 64 bit Windows GUI program that loads and displays 'packets' from the SWAG Pascal Code collection" |
| 13 | +download-base-url: "https://github.com/ddabapps/swagview/releases/tag/v" |
| 14 | +repo-url: "https://github.com/ddabapps/swagview" |
| 15 | +want-header-buttons: true |
| 16 | +copyright-date: "2023" |
| 17 | +status: "current" |
| 18 | +--- |
| 19 | +<section class="panel panel-default"> |
| 20 | + <div class="panel-heading"> |
| 21 | + <h2 class="panel-title"> |
| 22 | + Overview |
| 23 | + </h2> |
| 24 | + </div> |
| 25 | + <div class="panel-body"> |
| 26 | + <p> |
| 27 | + <em>SAWGView</em> is a Windows GUI application that displays "packets" (i.e. code snippets) from the <a href="https://github.com/delphidabbler/swag">SWAG Pascal Code Collection</a>. |
| 28 | + </p> |
| 29 | + <p> |
| 30 | + <img class="scale center-block" src="{{ site.data.core.software-images-base-url}}/swagview.png" alt="Screenshot of SWAGView program" title="SWAGView" /> |
| 31 | + </p> |
| 32 | + <p> |
| 33 | + This application offers basic features to load and navigate the collection. While useful, the program also serves as a proof of concept for loading and viewing the DelphiDabbler Edition of the SWAG collection. |
| 34 | + </p> |
| 35 | + <p> |
| 36 | + The core code was adapted from the SWAG import feature of <a href="./codesnip">CodeSnip</a>. |
| 37 | + </p> |
| 38 | + <p class="alert alert-info glyph"> |
| 39 | + When <em>SWAGView</em> is first installed it doesn't display anything until you also <a href="/help/swagview/0.0/getting-started">install SWAG</a>. |
| 40 | + </p> |
| 41 | + <p class="callout callout-info"> |
| 42 | + <span class="fa fa-copyright fa-pull-left fa-3x"></span><em>SWAGView</em> is copyright © {{ page.copyright-date}} by <a href="{{ site.data.core.gravatar-url }}" aria-label="{{ site.data.core.gravatar-link-title }}">Peter Johnson</a>. The program and its source code are released under the terms of the <a href="https://www.mozilla.org/en-US/MPL/2.0/">Mozilla Public License v2</a>. |
| 43 | + </p> |
| 44 | +</section> |
| 45 | + |
| 46 | +<section class="panel panel-default"> |
| 47 | + <div class="panel-heading"> |
| 48 | + <h2 class="panel-title"> |
| 49 | + Download & Installation |
| 50 | + </h2> |
| 51 | + </div> |
| 52 | + <div class="panel-body"> |
| 53 | + <p> |
| 54 | + This program is hosted on GitHub in the <code><a href="{{ page.repo-url }}">ddabapps/swagview</a></code> repository. The program can be downloaded from the repository's <a href="https://github.com/ddabapps/swagview/releases"><em>Releases</em></a> page. |
| 55 | + </p> |
| 56 | + <p> |
| 57 | + Each release gives the option of downloading either the programs's executable code or the source code. Your options are: |
| 58 | + </p> |
| 59 | + <h3> |
| 60 | + Executable program |
| 61 | + </h3> |
| 62 | + <p> |
| 63 | + Download <code>swagview-exe64-{{page.version}}.zip</code> if you a running 64 bit Windows or download <code>swagview-exe32-{{page.version}}.zip</code> for 32 bit Windows. |
| 64 | + </p> |
| 65 | + <p> |
| 66 | + There is no installer, so you need to install the program manually. Proceed as follows: |
| 67 | + </p> |
| 68 | + <ol> |
| 69 | + <li> |
| 70 | + Create a new sub-directory to store the program and its associated files. This can be created in any <em>writeable</em> directory on your system drive(s) or on a removable drive. |
| 71 | + </li> |
| 72 | + <li> |
| 73 | + Extract all the files from the zip file and copy them into the newly created directory. |
| 74 | + </li> |
| 75 | + <li> |
| 76 | + Optionally create a shortcut to the executable file in some convenient location. |
| 77 | + </li> |
| 78 | + <li> |
| 79 | + Run the program. It will prompt you to install the SWAG database. See the <a href="/help/swagview/0.0/getting-started">Getting Started</a> online help topic for details of how to do this. Once the installation is complete the database files will have been created in a <code>swag</code> sub-directory of the directory you created at step 1. |
| 80 | + </li> |
| 81 | + </ol> |
| 82 | + <h3> |
| 83 | + Source code |
| 84 | + </h3> |
| 85 | + <p> |
| 86 | + Source code is available in two formats. Download: |
| 87 | + </p> |
| 88 | + <ul> |
| 89 | + <li> |
| 90 | + <code>Source code.zip</code> to get the source code in <code>.zip</code> format. |
| 91 | + </li> |
| 92 | + <li> |
| 93 | + <code>Source code.tar.gz</code> to get the source code in a g-zipped tarball. |
| 94 | + </li> |
| 95 | + </ul> |
| 96 | + <p class="text-center"> |
| 97 | + <a class="btn btn-primary" role="button" href="{{ page.download-base-url }}{{ page.version }}" aria-label="Go to release v{{ page.version}} on GitHub">Get <span class="hidden-xs">release </span>v{{ page.version }} from GitHub</a> |
| 98 | + </p> |
| 99 | + </div> |
| 100 | +</section> |
| 101 | + |
| 102 | +<section class="panel panel-default"> |
| 103 | + <div class="panel-heading"> |
| 104 | + <h2 class="panel-title"> |
| 105 | + Documentation |
| 106 | + </h2> |
| 107 | + </div> |
| 108 | + <div class="panel-body"> |
| 109 | + <p> |
| 110 | + The following documentation is available. |
| 111 | + </p> |
| 112 | + <ul class="list-group"> |
| 113 | + <li class="list-group-item"> |
| 114 | + <span class="fa fa-fw fa-x-pad-right fa-file-text-o" aria-hidden="true"></span><a href="https://github.com/ddabapps/swagview/blob/main/README.md">Read Me<span class="sr-only"> (Markdown file)</span></a> – contains general information about the program, including instructions on how to install it. |
| 115 | + </li> |
| 116 | + <li class="list-group-item"> |
| 117 | + <span class="fa fa-fw fa-x-pad-right fa-file-text-o" aria-hidden="true"></span><a href="https://github.com/ddabapps/swagview/blob/main/CHANGELOG.md">Change Log<span class="sr-only"> (Markdown file)</span></a> – lists significant changes made in each program release. |
| 118 | + </li> |
| 119 | + <li class="list-group-item"> |
| 120 | + <span class="fa fa-fw fa-x-pad-right fa-file-text-o" aria-hidden="true"></span><a href="https://github.com/ddabapps/swagview/blob/main/LICENSE.txt">LICENSE.txt<span class="sr-only"> (Markdown file)</span></a> – the program's license. |
| 121 | + </li> |
| 122 | + <li class="list-group-item"> |
| 123 | + <span class="fa fa-fw fa-x-pad-right fa-question-circle" aria-hidden="true"></span><a href="/help/swagview/0.0/index">Online Help</a> |
| 124 | + </li> |
| 125 | + </ul> |
| 126 | + </div> |
| 127 | +</section> |
| 128 | + |
| 129 | +<section class="panel panel-default"> |
| 130 | + <div class="panel-heading"> |
| 131 | + <h2 class="panel-title"> |
| 132 | + Bugs & Feature Requests |
| 133 | + </h2> |
| 134 | + </div> |
| 135 | + <div class="panel-body"> |
| 136 | + <p> |
| 137 | + You can report bugs or suggest new features using the <em>SWAGView</em> <a href="https://github.com/ddabapps/swagview/issues" class="offsite">issue tracker</a> on GitHub. |
| 138 | + </p> |
| 139 | + <p> |
| 140 | + Please review existing bug reports and feature requests before creating a new issue. If an issue already exists you may be able to help by adding a further comment. |
| 141 | + </p> |
| 142 | + <p class="alert alert-info glyph"> |
| 143 | + You will need a GitHub account if you want to create or edit an issue. |
| 144 | + </p> |
| 145 | + </div> |
| 146 | +</section> |
0 commit comments