Merge pull request #686 from KhalisFoundation/master

5.2 Release

HELP.md

@@ -1,5 +1,5 @@
-
 ## FAQ
+
 [How do I search for a shabad?](#how-to-search)
 
 [How do I type in Gurmukhi?](#type-in-gurmukhi)
@@ -32,8 +32,6 @@
 
 [Video Tutorial](#video-tutorial)
 
-
-
 ### <a name="how-to-search">How do I search for a shabad?</a>
 
 After launching SikhiToTheMax, by default you can search for a shabad by entering the first letter of each word. For example, if the shabad is `ਗੁਰੁ ਮੇਰੈ ਸੰਗਿ ਸਦਾ ਹੈ ਨਾਲੇ`, you would enter `gmsshn`. ![](./assets/img/help_images/search_example.gif)
@@ -52,18 +50,22 @@ After launching SikhiToTheMax, click the icon for Themes and choose your preferr
 
 ### <a name="search-type">What do the different search types do?</a>
 
-*   First Letter (Start)
-    *   The letters you input must be from the START of a line in a shabad.
-
-*   First Letter (Anywhere)
-    *   The letters you input can be from any part of the line. For example, you can start your search by typing in the first letter of every word in the second half of a shabad’s line.
-
-*   Full Word (Gurmukhi)
-    *   You can type in the full word(s) in gurmukhi that you are searching for.
-
-*   English Translation (Full Word)
-    *   You can search for shabads via the english translations. For example, type in the word "bird" and the results will show all shabads that include a translation for "bird".
-
+- First Letter (Start)
+
+  - The letters you input must be from the START of a line in a shabad.
+
+- First Letter (Anywhere)
+
+  - The letters you input can be from any part of the line. For example, you can start your search by typing in the first letter of every word in the second half of a shabad’s line.
+
+- Full Word (Gurmukhi)
+
+  - You can type in the full word(s) in gurmukhi that you are searching for.
+
+- English Translation (Full Word)
+
+  - You can search for shabads via the english translations. For example, type in the word "bird" and the results will show all shabads that include a translation for "bird".
+
 ### <a name="wildcard">Using wildcard when searching</a>
 
 If you are unsure of a letter when searching, you can enter in a `*` as a wildcard search operator. This will act as a placeholder and will find results against every letter. For example, if the shabad is ਗੁਰੁ ਮੇਰੈ ਸੰਗਿ ਸਦਾ ਹੈ ਨਾਲੇ , you can enter `gms*hn`.
@@ -72,11 +74,9 @@ If you are unsure of a letter when searching, you can enter in a `*` as a wildca
 
 Plug in your computer to the projector or TV. Once you do this, go to your computer's display settings and change it to "Extended Desktop" (NOT mirroring). After that, launch SikhiToTheMax and turn on "Presenter View" in the settings! ![](./assets/img/help_images//desktop-extend-pc.png) ![](./assets/img/help_images/desktop-extend-mac.png)
 
-
 ### <a name="larivaar">Can you view the Gurbani in Larivaar?</a>
 
-Yes! After launching SikhiToTheMax, click the icon for Display Settings, and choose the Larivaar option. 
-
+Yes! After launching SikhiToTheMax, click the icon for Display Settings, and choose the Larivaar option.
 
 ### <a name="sundar-gutka">What is Sundar Gutka?</a>
 
@@ -86,7 +86,7 @@ Sundar Gutka is a a list of frequently read Banis such as Sukhmani Sahib, Asa Ke
 
 Throughout the past few centuries, there have been many different “sampardhas” or “jathas” that have been conceived from the core concepts of Sikhi and Gurmat. These sampardhas often have different opinions and thoughts about some aspects of Sikh history, Gurbani and Rehat, but still fall collectively under the united Khalsa Panth and, most importantly, the Akaal Takht. The Akaal Takht is the highest order and institution that all Sikhs adhere to.
 
-These differences have also brought about different recommendations about compiled Baanis and the Paath (prayers) that we read on a daily basis which makes it difficult to create a single Sundar Gutka  with a single version of Paath that would satisfy everyone. 
+These differences have also brought about different recommendations about compiled Baanis and the Paath (prayers) that we read on a daily basis which makes it difficult to create a single Sundar Gutka with a single version of Paath that would satisfy everyone.
 
 We therefore have created the option to select lengths of what Paath you do that apply to four of the main Banis read most often. These have been structured in relation to length but all have a minimum of the SGPC standard or fall under the Akaal Takht. We do not include any versions that are by sampardhas excommunicated by the Akaal Takht as a standard.
 
@@ -102,60 +102,60 @@ LONG: Typically read by followers of Damdami Taksaal and others.
 
 EXTRA LONG: Most popular amongst followers of Buddha Dal.
 
-You can adjust Bani Length in the Settings tab. 
+You can adjust Bani Length in the Settings tab.
 
 ### <a name="vishraams">What are Vishraams?</a>
 
-Vishraams indicate pauses in Gurbani. There are both long pauses and short pause that are denoted by different colors (see next question). It is important to note that Vishraams are interpretations from Gursikhs and are not written directly in Guru Granth Sahib Jee. 
+Vishraams indicate pauses in Gurbani. There are both long pauses and short pause that are denoted by different colors (see next question). It is important to note that Vishraams are interpretations from Gursikhs and are not written directly in Guru Granth Sahib Jee.
 
 ### <a name="vishraams-options">What are the Vishraam styles and sources?</a>
 
 The Khalis team preformed a user study to determine the best way to display Vishraams. You have the option (in the Settings) to choose between Colored Words or a Gradient Background. Colors are defined below:
 
-*   Colored Text:
-    *   *Red* - long pause
-    *   *Yellow* - short pause
-
+- Colored Text:
+
+  - _Red_ - long pause
+  - _Yellow_ - short pause
+
 Additionally, you have the option to choose between Vishraam sources:
 
-*   Sources:
-    *   *STTM Living* - Vishraams being actively updated/corrected by the Khalis Foundation team of sevaadaars
-    *   *iGurbani* - Vishraams as shown in the iGurbani mobile app
-     *  *STTM 2* - Vishraams as shown in the old SikhiToTheMax 2 app
+- Sources:
+  - _BaniDB Living_ - Vishraams being actively updated/corrected by the BaniDB & Khalis Foundation team of sevaadaars
+  - _iGurbani_ - Vishraams as shown in the iGurbani mobile app
+  - _STTM 2_ - Vishraams as shown in the old SikhiToTheMax 2 app
 
 ### <a name="additional-info">Additional Database/Search Information</a>
 
-*   SikhiToTheMax's database includes shabads from Sri Guru Granth Sahib Ji, Sri Dasam Granth Sahib, Bhai Gurdas Jee, Bhai Gurdas Singh Jee, Bhai Nand Lal Jee, and various rehatnamas and thankhanamas. If your shabad is not from one of those sources, it will not appear.
-*   If you verified your shabad should be in the database and it is still not coming up, make sure you are typing in the correct letters for search. If you aren’t sure about a letter, or are still having difficulties, try using one of the different search types to locate the shabad.
-*   If you don't know one of the letters, consider using an asterisk in its place. Here's some information on how it works:
-    *   *First letter start* - 
-        `ssnh` it will search for “soche soch na hovayi je sochi lakh vaar”  not “jat sat sanjam naam hai”
-    *   *First letter anywhere* - 
-        `ssnh` it will search for “soche soch na hovayi je sochi lakh vaar” and “jat sat sanjam naam hai”
-    *   *First letter start* - 
-        `*ssnh` will search for “jat sat sanjam naam hai” and not “soche soch na hovayi je sochi lakh vaar”
-    *   *First letter anywhere* - 
-        `*ssnh` will search for “jat sat sanjam naam hai” and not “soche soch na hovayi je sochi lakh vaar”
-    *   *First letter start* - 
-        `ssnh*` will search for “soche soch na hovayi je sochi lakh vaar” and not  “jat sat sanjam naam hai”
-    *   *First letter anywhere* - 
-        `ssnh*` will search for “soche soch na hovayi je sochi lakh vaar” and  “jat sat sanjam naam hai”
-    *   *First letter start* - 
-        `ss*nh` will search for “sukh sagar har naam hai” and neither “soche soch na hovayi..” nor “rasna sacha simriye man tan nirmal hoye”
-    *   *First letter anywhere* - 
-        `ss*nh` will search for “sukh sagar har naam hai” and “rasna sacha simriye man tan nirmal hoye” but not “soche soch na hovayi…”
-
+- SikhiToTheMax's database includes shabads from Sri Guru Granth Sahib Ji, Sri Dasam Granth Sahib, Bhai Gurdas Jee, Bhai Gurdas Singh Jee, Bhai Nand Lal Jee, and various rehatnamas and thankhanamas. If your shabad is not from one of those sources, it will not appear.
+- If you verified your shabad should be in the database and it is still not coming up, make sure you are typing in the correct letters for search. If you aren’t sure about a letter, or are still having difficulties, try using one of the different search types to locate the shabad.
+- If you don't know one of the letters, consider using an asterisk in its place. Here's some information on how it works:
+  - _First letter start_ -
+    `ssnh` it will search for “soche soch na hovayi je sochi lakh vaar” not “jat sat sanjam naam hai”
+  - _First letter anywhere_ -
+    `ssnh` it will search for “soche soch na hovayi je sochi lakh vaar” and “jat sat sanjam naam hai”
+  - _First letter start_ -
+    `*ssnh` will search for “jat sat sanjam naam hai” and not “soche soch na hovayi je sochi lakh vaar”
+  - _First letter anywhere_ -
+    `*ssnh` will search for “jat sat sanjam naam hai” and not “soche soch na hovayi je sochi lakh vaar”
+  - _First letter start_ -
+    `ssnh*` will search for “soche soch na hovayi je sochi lakh vaar” and not “jat sat sanjam naam hai”
+  - _First letter anywhere_ -
+    `ssnh*` will search for “soche soch na hovayi je sochi lakh vaar” and “jat sat sanjam naam hai”
+  - _First letter start_ -
+    `ss*nh` will search for “sukh sagar har naam hai” and neither “soche soch na hovayi..” nor “rasna sacha simriye man tan nirmal hoye”
+  - _First letter anywhere_ -
+    `ss*nh` will search for “sukh sagar har naam hai” and “rasna sacha simriye man tan nirmal hoye” but not “soche soch na hovayi…”
 
 ### <a name="bani-overlay">What is Bani Overlay?</a>
 
-Bani Overlay allows you to display Gurbani from SikhiToTheMax on a Live Stream. It will require a third party software such as OBS. To learn more, watch this video: 
+Bani Overlay allows you to display Gurbani from SikhiToTheMax on a Live Stream. It will require a third party software such as OBS. To learn more, watch this video:
 
 <div class="video-wrapper"><iframe width="100%" height="400px" src="https://www.youtube.com/embed/WrckmAcwboM" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen=""></iframe></div>
 
 ### <a name="report-mistake">How do I report a mistake?</a>
 
 Visit [SikhiToTheMax.org](https://sikhitothemax.org) and click "[Feedback](https://goo.gl/plk23h)" at the bottom of the page.
 
-###  <a name="video-tutorial">Video Tutorial</a>
+### <a name="video-tutorial">Video Tutorial</a>
 
 <div class="video-wrapper"><iframe width="100%" height="400px" src="https://www.youtube.com/embed/ZDX8nPkDBSc" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen=""></iframe></div>

LEGEND.md

@@ -0,0 +1,51 @@
+## Table of Contents
+
+[1. Keyboard Mappings](#mappings)
+
+[2. Slide Shortcuts](#slides)
+
+[3. Others](#others)
+
+### <a name="mappings">Keyboard Mappings</a>
+
+![](./assets/img/help_images/web-desktop-keyboard-map.png)
+
+- _Note that the chars on the top require shift + key._
+
+### <a name="slides">Slide Shortcuts</a>
+
+#### macOS:
+
+- Cmd + 1 = Waheguru Slide
+- Cmd + 2 = Mool Mantra Slide
+- Cmd + 3 = Empty Slide
+- Cmd + 4 = Anand Sahib (Bhog)
+- Cmd + 5 = Help Guide
+- Cmd + 6 = Shortcut Legend
+- Cmd + / = Jump to search
+
+#### Windows:
+
+- Ctrl + 1 = Waheguru Slide
+- Ctrl + 2 = Mool Mantra Slide
+- Ctrl + 3 = Empty Slide
+- Ctrl + 4 = Anand Sahib (Bhog)
+- Ctrl + 5 = Help Guide
+- Ctrl + 6 = Shortcut Legend
+- Cmd + / = Jump to search
+
+### <a name="others">Others</a>
+
+#### macOS:
+
+- Cmd + q = Close app (shut down app)
+- Cmd w = Close app (shut down app)
+- Cmd + u = check for updates
+- Cmd + h = minimize window
+- Cmd + m = minimize window
+
+#### Windows:
+
+- Ctrl + q = Close app (shut down app)
+- Ctrl + u = Check for update
+- Ctrl + m = minimize window

README.md

@@ -13,28 +13,31 @@ Acknowledgements: Bhai Tarsem Singh UK, SHARE UK, Khalis Foundation, Khalsa Foun
 
 Powered by [<img height="30" src="http://www.banidb.com/wp-content/uploads/2018/03/full-banidb-logo.png">](http://banidb.com)
 
-
 [![Build Status](https://api.travis-ci.org/KhalisFoundation/sttm-desktop.svg?branch=release)](https://travis-ci.org/KhalisFoundation/sttm-desktop) [![Build Status](https://ci.appveyor.com/api/projects/status/github/khalisfoundation/sttm-desktop?branch=release&svg=true)](https://ci.appveyor.com/project/navdeepsinghkhalsa/sttm-desktop)
 
 ## Prerequisites
- 1. [Node](https://nodejs.org/en/download/)
- 2. [Github SSH Key Setup](https://help.github.com/articles/connecting-to-github-with-ssh/)
+
+1.  [Node](https://nodejs.org/en/download/)
+2.  [Github SSH Key Setup](https://help.github.com/articles/connecting-to-github-with-ssh/)
 
 ## Installation
- * Clone repository
- * Run `npm install` in the repository root
+
+- Clone repository
+- Run `npm install` in the repository root
 
 ## Running
- * Run `npm start` in the repository root
+
+- Run `npm start` in the repository root
 
 ## Packaging
 
 Create the app package for your system:
 
- * **macOS** - Run `npm run pack:mac`
- * **Windows 64-bit** - Run `npm run pack:win`
- * **Windows 32-bit** - Run `npm run pack:win32`
- * **Linux/Ubuntu 64-bit** - Run `npm run pack:linux`
+- **macOS** - Run `npm run pack:mac`
+- **Windows 64-bit** - Run `npm run pack:win`
+- **Windows 32-bit** - Run `npm run pack:win32`
+- **Linux/Ubuntu 64-bit** - Run `npm run pack:linux`
 
 ## Contributing
-See [CONTRIBUTING.md](CONTRIBUTING.md)
+
+Please see [CONTRIBUTING.md](CONTRIBUTING.md)

app.js

@@ -83,6 +83,10 @@ const secondaryWindows = {
     obj: false,
     url: `file://${__dirname}/www/overlay.html`,
   },
+  shortcutLegend: {
+    obj: false,
+    url: `file://${__dirname}/www/legend.html`,
+  },
 };
 let manualUpdate = false;
 const viewerWindowPos = {};
@@ -298,7 +302,7 @@ const shouldQuit = app.makeSingleInstance(() => {
 });
 
 if (shouldQuit) {
-  app.quit();
+  app.exit();
 }
 
 app.on('ready', () => {
@@ -455,6 +459,17 @@ ipcMain.on('show-text', (event, arg) => {
   }
 });
 
+ipcMain.on('presenter-view', (event, arg) => {
+  if (viewerWindow) {
+    if (!arg) {
+      viewerWindow.hide();
+    } else {
+      viewerWindow.show();
+      viewerWindow.setFullScreen(true);
+    }
+  }
+});
+
 ipcMain.on('scroll-from-main', (event, arg) => {
   if (viewerWindow) {
     viewerWindow.webContents.send('send-scroll', arg);

package.json

@@ -1,7 +1,7 @@
 {
   "productName": "SikhiToTheMax",
   "name": "sttm-desktop",
-  "version": "5.0.0",
+  "version": "5.2.0",
   "description": "The SikhiToTheMax desktop app",
   "main": "app.js",
   "scripts": {