Merge pull request #2 from withdave/v2.0.1-fixes

V2.0.1 fixes - note that the extension directory and name has changed

.gitignore

@@ -1,3 +1,44 @@
+## GitIgnore built from own experience and using samples from https://github.com/github/gitignore
+## DC - 20190920
+
+## Qlik exclusions
+# Ignore all Qlik data files
+*.qvd
+
+
+## Windows exclusions
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+## Dropbox exclusions
+# Dropbox settings and caches
+.dropbox
+.dropbox.attr
+.dropbox.cache
+
+## MacOS exclusions
 # General
 .DS_Store
 .AppleDouble
@@ -8,4 +49,23 @@ Icon
 
 
 # Thumbnails
-._*
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Finally I want to exclude any packages I might make
+*.zip

README.md

@@ -1,12 +1,12 @@
-# Qlik Sense App Icon Generator
+# Qlik Sense Icon Generator (qs-icon-generator)
 
 The requirements for a Qlik Sense App Icon are:
 - Suitable format - ideally PNG file, but can be JPG, JPEG or GIF
 - Correct size or aspect - actual size for the hub is 168x108 pixels (although the help site says 8:5 - https://help.qlik.com/en-US/sense/June2019/Subsystems/Hub/Content/Sense_Hub/Apps/change-thumbnail-app.htm, and in-app this is also different)
 
 # Usage
 
-This has been packaged as an extension, so just upload it under extensions in the QMC, then navigate to /extensions/AppIconBuilder/AppIconBuilder.html to create some icons.
+This has been packaged as an extension, so just upload it under extensions in the QMC, then navigate to /extensions/qs-icon-generator/index.html to create some icons.
 
 Example implementation:
 ![Default configuration, with a green logo generated](screenshot.png)
@@ -32,9 +32,19 @@ Current backlog:
 * Add config for source image (source, scaling, opacity) or for a single colour background (v2.0)
 * Add config for app name (font, colour, size, location) (v2.0)
 * Add wrapping for app names (v2.0)
+* Update wbl file to include correct references (v2.0.1)
+* Add reference back to GitHub for future versions (v2.0.1)
+* Update .gitignore to include mac and other formats (and remove from deployment package) (v2.0.1)
 
 # Updates
 
+## v2.0.1
+
+* Updated wbl file to include correct references for editing in the dev-hub
+* Add reference back to GitHub for future versions
+* Tidied unwanted system files and gitignore
+* Renamed plugin to align repository, estension and intended purpose
+
 ## v2.0
 
 * Moved to using releases

src/AppIconBuilder/AppIconBuilder.html → src/qs-icon-generator/index.html

@@ -6,7 +6,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
   <meta name="description" content="">
   <meta name="author" content="withdave">
-  <title>Qlik Sense App Icon Builder</title>
+  <title>Qlik Sense Icon Generator</title>
 
   <!-- Bootstrap core CSS -->
   <link href="css/bootstrap.min.css" rel="stylesheet">
@@ -37,7 +37,7 @@
   <main role="main" class="container">
 
     <div class="qsi-header">
-      <h1>Qlik Sense App Icon Builder v2.0</h1>
+      <h1>Qlik Sense Icon Generator v2.0.1</h1>
       <p class="lead">This tool is designed to help you produce standardised, consistent app icons.</p>
     </div>
 
@@ -89,12 +89,11 @@ <h3>Tool configuration</h3>
         <p>To use this tool effectively:</p>
         <ul>
           <li>Create a background image of 164x108px (as per Qlik help this should be ratio 8:5, however this doesn't
-            match to match the size the image is rescaled for the Hub, or alternatively of size 190x116 to match the
-            size the image is rescaled to in-app) and store this in the mashup directory as "icon_background.png".</li>
-          <li>Set the default opacity for the background image, by changing the default value in this HTML file. By
-            default this is fully opaque (1).</li>
+            match to match the size the image is rescaled for the Hub or in app) and store this in the backgrounds directory with an appropriate name (this will be referenced in the config.json file).</li>
+          <li>Update config.json with the new theme details. Use the dev-hub to edit this without needing to import/export the extension.</li>
           <li>Change the default app types, if needed. The defaults are "N/A" (blank), "Dashboard", "Transform",
             "Extract" and "Trigger" to signify the purpose of the application the icon is being generated for.</li>
+          <li>Periodically check <a href="https://github.com/withdave/qlik-sense-icon-generator">GitHub</a> for updates to this extension.</li>
         </ul>
       </div>
     </div>
@@ -107,4 +106,4 @@ <h3>Tool configuration</h3>
 
 </body>
 
-</html>
+</html>

src/qs-icon-generator/qs-icon-generator.qext

@@ -0,0 +1,14 @@
+{
+    "type": "mashup",
+    "name": "Qlik Sense Icon Builder (qs-icon-generator)",
+    "description": "This tool is designed to help you produce standardised, consistent app icons.",
+    "version": "2.0.1",
+    "author": "withdave",
+    "homepage": "https://github.com/withdave/qlik-sense-icon-generator",
+    "keywords": "",
+    "license": "",
+    "repository": "https://github.com/withdave/qlik-sense-icon-generator",
+    "dependencies": {
+        "qlik-sense": ">=3.0.x"
+    }
+}

src/qs-icon-generator/wbfolder.wbl

@@ -0,0 +1,3 @@
+qs-icon-generator.qext;
+index.html;
+config.json;