diff --git a/app/db/README.md b/app/db/README.md index bea704dd..64c63192 100644 --- a/app/db/README.md +++ b/app/db/README.md @@ -28,16 +28,6 @@ To get more help on the Angular CLI use `ng help` or go check out the [Angular C # Punch List -- Options to merge references \*\* - - Merge if overlap - - Merge if contains - - Merge if equals - - Don't merge -- Page Admin \*\* - - Delete Page - - Show pages and list of card titles for each page in expansion panel - - Remove card from page - - Make page public (private edit only) [available only when logged in] - Notes Admin \*\* - List notes by title - Edit Note @@ -52,9 +42,12 @@ To get more help on the Angular CLI use `ng help` or go check out the [Angular C - remove old ionic project - setup CI/CD - ignore reserved search words (the ones that are too big to fit in the index) +- migration path for old data to new ## Optionally for Future +- Page Admin + - Make page public (private edit only) [available only when logged in] - Edit card query - Swipe to close - Settings for theme diff --git a/app/db/src/app/app-routing.module.ts b/app/db/src/app/app-routing.module.ts index baded72a..c6dc2ff8 100644 --- a/app/db/src/app/app-routing.module.ts +++ b/app/db/src/app/app-routing.module.ts @@ -2,6 +2,7 @@ import { NgModule } from '@angular/core'; import { Routes, RouterModule } from '@angular/router'; import { SearchPage } from './pages/search/search.page'; import { SavedPagesAdminPage } from './pages/saved-pages-admin/saved-pages-admin.page'; +import { HelpPage } from './components/help/help.page'; const routes: Routes = [ { diff --git a/app/db/src/app/app.component.html b/app/db/src/app/app.component.html index 30dfe6f5..e66fe055 100644 --- a/app/db/src/app/app.component.html +++ b/app/db/src/app/app.component.html @@ -16,6 +16,9 @@ [routerLink]="[p.route]" >{{ p.icon }} {{ p.title }} + helpHelp Saved Pages diff --git a/app/db/src/app/app.component.ts b/app/db/src/app/app.component.ts index 19e51ce8..deac3f87 100644 --- a/app/db/src/app/app.component.ts +++ b/app/db/src/app/app.component.ts @@ -8,6 +8,8 @@ import { map, shareReplay } from 'rxjs/operators'; import { MatSidenav } from '@angular/material/sidenav'; import { SubscriberBase } from './common/subscriber-base'; import { MatSnackBar } from '@angular/material/snack-bar'; +import { HelpModalComponent } from './components/help-modal/help-modal.component'; +import { MatDialog } from '@angular/material/dialog'; @Component({ selector: 'app-root', @@ -34,7 +36,8 @@ export class AppComponent extends SubscriberBase implements AfterViewInit { private navService: NavService, private storageService: StorageService, private breakpointObserver: BreakpointObserver, - private snackBar: MatSnackBar + private snackBar: MatSnackBar, + public dialog: MatDialog ) { super(); @@ -87,6 +90,10 @@ export class AppComponent extends SubscriberBase implements AfterViewInit { //#endregion } + showHelp() { + this.dialog.open(HelpModalComponent); + } + ngAfterViewInit(): void { this.navService.setSidenav(this.sidenav, this.settings); } diff --git a/app/db/src/app/app.module.ts b/app/db/src/app/app.module.ts index 978b3cd6..727af822 100644 --- a/app/db/src/app/app.module.ts +++ b/app/db/src/app/app.module.ts @@ -56,6 +56,8 @@ import { AppComponent } from './app.component'; import { SavedPagesAdminPage } from './pages/saved-pages-admin/saved-pages-admin.page'; import { SavedPageCardComponent } from './components/saved-page-card/saved-page-card.component'; +import { HelpModalComponent } from './components/help-modal/help-modal.component'; + import { SearchPage } from './pages/search/search.page'; import { OkCancelModalComponent } from './components/ok-cancel-modal/ok-cancel-modal.component'; @@ -77,6 +79,7 @@ import { AddToPageModalComponent } from './components/add-to-page-modal/add-to-p AppComponent, SavedPagesAdminPage, SavedPageCardComponent, + HelpModalComponent, SearchPage, PassageCardComponent, StrongsComponent, diff --git a/app/db/src/app/components/help-modal/help-modal.component.html b/app/db/src/app/components/help-modal/help-modal.component.html new file mode 100644 index 00000000..36ba5782 --- /dev/null +++ b/app/db/src/app/components/help-modal/help-modal.component.html @@ -0,0 +1,174 @@ + + help + Help + + + + +
+

How to search for a verse

+

+ To bring up a passage, just type in a reference, or use the verse picker in + the top right corner. Dynamic Bible will recognize most abbreviations of + books, and can handle ranges within a book. Here are a few examples to get + you started: +

+

Examples of Search Items:

+ + + We currently don't support ranges that cross book boundaries. If you search + for "John 12 - Romans 3" you will get an error. the second book name is + ignored. + +

Further Notes:

+ + +

Visit Us Online

+

+ www.dynamicbible.com hosts the + online version of the web app. We are currently available on the + Windows Platform + via the Electron app from atom.io and + on the + Google Android Play store. We are working on an IOS distribution and will be releasing that soon. +

+ +

Book Names and Accepted Abbreviations

+ +
diff --git a/app/db/src/app/components/help-modal/help-modal.component.scss b/app/db/src/app/components/help-modal/help-modal.component.scss new file mode 100644 index 00000000..0eaad663 --- /dev/null +++ b/app/db/src/app/components/help-modal/help-modal.component.scss @@ -0,0 +1,18 @@ +.close-button { + float: right; + mat-icon { + font-size: 2rem; + } +} + +.title { + width: 100%; + padding-left: 1rem; + font-size: 1.5rem; +} + +.content { + margin-top: 12px; + max-height: 80vh; + overflow-y: scroll; +} diff --git a/app/db/src/app/components/help-modal/help-modal.component.ts b/app/db/src/app/components/help-modal/help-modal.component.ts new file mode 100644 index 00000000..1c0435e7 --- /dev/null +++ b/app/db/src/app/components/help-modal/help-modal.component.ts @@ -0,0 +1,12 @@ +import { Component } from '@angular/core'; +import { NavService } from '../../services/nav.service'; + +@Component({ + selector: 'app-help-modal-component', + templateUrl: './help-modal.component.html', + styleUrls: ['./help-modal.component.scss'], + preserveWhitespaces: true, +}) +export class HelpModalComponent { + constructor(public navService: NavService) {} +} diff --git a/app/db/src/app/pages/saved-pages-admin/saved-pages-admin.page.ts b/app/db/src/app/pages/saved-pages-admin/saved-pages-admin.page.ts index c3d9f24e..8d5a5dc8 100644 --- a/app/db/src/app/pages/saved-pages-admin/saved-pages-admin.page.ts +++ b/app/db/src/app/pages/saved-pages-admin/saved-pages-admin.page.ts @@ -1,4 +1,4 @@ -import { Component, OnInit, ChangeDetectionStrategy } from '@angular/core'; +import { Component, OnInit } from '@angular/core'; import { MatDialog } from '@angular/material/dialog'; import { AppService } from '../../services/app.service'; import { NavService } from '../../services/nav.service'; diff --git a/app/db/src/app/services/app-state-initial-state.ts b/app/db/src/app/services/app-state-initial-state.ts index d61cf03b..d3cabce7 100644 --- a/app/db/src/app/services/app-state-initial-state.ts +++ b/app/db/src/app/services/app-state-initial-state.ts @@ -33,7 +33,6 @@ export const initialState: AppState = { mainPages: [ { title: PageTitles.Search, icon: PageIcons.Search, route: 'search' }, { title: PageTitles.PageAdmin, icon: PageIcons.PageAdmin, route: 'saved/admin' }, - { title: PageTitles.Help, icon: PageIcons.Help, route: 'help' }, ], error: null, displaySettings: {