diff --git a/common/constants.js b/common/constants.js index 1527bc74e86405a3f23353e182103e9a7da31882..e36459f7a686904b39156256673842f9f8142814 100644 --- a/common/constants.js +++ b/common/constants.js @@ -129,4 +129,7 @@ LAYER_SELECTOR: `This is the atlas layer browser. If an atlas supports multiple template spaces or parcellation maps, you will find them here.`, STATUS_CARD: `This is the coordinate navigator. Expand it to manipulate voxel and physical coordinates, to reset the view, or to create persistent links to the current view for sharing.`, } + + exports.QUICKTOUR_DESC_MD = { + } })(typeof exports === 'undefined' ? module.exports : exports) diff --git a/common/howToCite.md b/common/howToCite.md new file mode 100644 index 0000000000000000000000000000000000000000..4be44dce356b79665d06b34f423b33d34cf7a5e5 --- /dev/null +++ b/common/howToCite.md @@ -0,0 +1,29 @@ +## How to cite from siibra-explorer + + +You will find a "chip" shaped label at the bottom-left of the screen (next to the layer selector) which indicates your currently selected parcellation map, e.g. _Julich-Brain Cytoarchitectonic Maps 2.9_. Here click on (i) + + +[](assets/images/how-to-cite-1.png) + + +This will subsequently open up a description box with an "Explore" button (box-and-arrow icon) at the bottom. + + +--- + + +[](assets/images/how-to-cite-2.png) + + + +Click on this button, which will lead you to the EBRAINS Knowledge Graph webpage for the complete parcellation map dataset. Here you can click on the "How to cite" option on the left to access the appropriate citation for your selected parcellation/template. + + +--- + + +[](assets/images/how-to-cite-3.png) + + +In addition, don't forget to also cite the _siibra-explorer_ website: <https://atlases.ebrains.eu/viewer/> diff --git a/docs/releases/v2.6.5.md b/docs/releases/v2.6.5.md index 9cf83b085c6deffc754bbad8c84744256def20d7..94c6efce508ba4befd0c901c7dd81f0104e9b618 100644 --- a/docs/releases/v2.6.5.md +++ b/docs/releases/v2.6.5.md @@ -1,5 +1,6 @@ -# v2.6.4 +# v2.6.5 ## Feature - Re-enabled autoradiographs for receptor datasets +- Added how-to-cite as a part of quick tour (#1085) diff --git a/src/assets/images/how-to-cite-1.png b/src/assets/images/how-to-cite-1.png new file mode 100644 index 0000000000000000000000000000000000000000..79fbf8be7cdf85d0b8c57ce383a13342af172c9a Binary files /dev/null and b/src/assets/images/how-to-cite-1.png differ diff --git a/src/assets/images/how-to-cite-2.png b/src/assets/images/how-to-cite-2.png new file mode 100644 index 0000000000000000000000000000000000000000..b917624cf0857b7140cfd5e0cc8abb0e2462e43e Binary files /dev/null and b/src/assets/images/how-to-cite-2.png differ diff --git a/src/assets/images/how-to-cite-3.png b/src/assets/images/how-to-cite-3.png new file mode 100644 index 0000000000000000000000000000000000000000..1d5c51a6ab6ee1777f714789de1e70459993bfda Binary files /dev/null and b/src/assets/images/how-to-cite-3.png differ diff --git a/src/environments/environment.common.ts b/src/environments/environment.common.ts index 85a5e68ae63408c740790bd514fb6ad3fdbe8bb2..83bad8bcb9a8fe4ec1e40eb4e419d41dc7748294 100644 --- a/src/environments/environment.common.ts +++ b/src/environments/environment.common.ts @@ -5,7 +5,7 @@ export const environment = { PRODUCTION: true, BACKEND_URL: null, DATASET_PREVIEW_URL: 'https://hbp-kg-dataset-previewer.apps.hbp.eu/v2', - BS_REST_URL: 'https://siibra-api-latest.apps-dev.hbp.eu/v1_0', + BS_REST_URL: 'https://siibra-api-rc.apps.hbp.eu/v1_0', SPATIAL_TRANSFORM_BACKEND: 'https://hbp-spatial-backend.apps.hbp.eu', MATOMO_URL: null, MATOMO_ID: null, diff --git a/src/ui/help/helpOnePager/helpOnePager.component.ts b/src/ui/help/helpOnePager/helpOnePager.component.ts index 7f047318658a162397bb4d6c50133927a475c278..f7afe35c9306a196b0c4bc0e20f1e9ee447258c7 100644 --- a/src/ui/help/helpOnePager/helpOnePager.component.ts +++ b/src/ui/help/helpOnePager/helpOnePager.component.ts @@ -1,6 +1,8 @@ +import { MatDialog } from '@angular/material/dialog'; import { Component, Optional } from "@angular/core"; import { PureContantService } from "src/util"; import { ARIA_LABELS } from 'common/constants' +import { HowToCite } from '../howToCite/howToCite.component'; // eslint-disable-next-line @typescript-eslint/no-var-requires const { default: QUICK_STARTER } = require('!!raw-loader!common/helpOnePager.md') @@ -19,11 +21,16 @@ export class HelpOnePager{ public extQuickStarter: string public userDoc: string constructor( - @Optional() pConstService: PureContantService + @Optional() pConstService: PureContantService, + private dialog: MatDialog, ){ this.extQuickStarter = `quickstart.html` if (pConstService) { this.userDoc = pConstService.docUrl } } + + howToCite(){ + this.dialog.open(HowToCite) + } } diff --git a/src/ui/help/helpOnePager/helpOnePager.template.html b/src/ui/help/helpOnePager/helpOnePager.template.html index ebf014b77a1c45468f6e56966756a0f542563c37..af0ae2e65b7bd8a6047e026165ad922f98662267 100644 --- a/src/ui/help/helpOnePager/helpOnePager.template.html +++ b/src/ui/help/helpOnePager/helpOnePager.template.html @@ -15,6 +15,15 @@ </div> <div mat-dialog-actions align="center"> + + <button mat-button color="primary" + (click)="howToCite()"> + <i class = "fas fa-book m-1"></i> + <span> + How to cite + </span> + </button> + <button mat-button color="primary" mat-dialog-close quick-tour-opener> <i class = "far fa-play-circle m-1"></i> <span> diff --git a/src/ui/help/howToCite/howToCite.component.ts b/src/ui/help/howToCite/howToCite.component.ts new file mode 100644 index 0000000000000000000000000000000000000000..fc1e94ff62572e6eff7cc0be5edab12232a950e1 --- /dev/null +++ b/src/ui/help/howToCite/howToCite.component.ts @@ -0,0 +1,16 @@ +import { Component } from "@angular/core"; + +// eslint-disable-next-line @typescript-eslint/no-var-requires +const { default: HOWTOCITE } = require('!!raw-loader!common/howToCite.md') + +@Component({ + selector: 'how-to-cite', + templateUrl: './howToCite.template.html', + styleUrls: [ + './howToCite.style.css' + ] +}) + +export class HowToCite{ + public HOWTOCITE = HOWTOCITE +} \ No newline at end of file diff --git a/src/ui/help/howToCite/howToCite.style.css b/src/ui/help/howToCite/howToCite.style.css new file mode 100644 index 0000000000000000000000000000000000000000..be8e9d87a469b5adc6608260adcbf1780f45206b --- /dev/null +++ b/src/ui/help/howToCite/howToCite.style.css @@ -0,0 +1,4 @@ +:host >>> img +{ + width: 100%; +} \ No newline at end of file diff --git a/src/ui/help/howToCite/howToCite.template.html b/src/ui/help/howToCite/howToCite.template.html new file mode 100644 index 0000000000000000000000000000000000000000..a5bc97e40d64efcc7d03ac3b06a3276b0e335c54 --- /dev/null +++ b/src/ui/help/howToCite/howToCite.template.html @@ -0,0 +1,2 @@ +<markdown-dom mat-dialog-content [markdown]="HOWTOCITE"> +</markdown-dom> \ No newline at end of file diff --git a/src/ui/help/module.ts b/src/ui/help/module.ts index 76f53a9e8423c731ad32c6b429831b129155b6c8..b99786401f97aad174c2e5db0398223d377be5c7 100644 --- a/src/ui/help/module.ts +++ b/src/ui/help/module.ts @@ -6,6 +6,7 @@ import { AngularMaterialModule } from "src/sharedModules"; import { AboutCmp } from './about/about.component' import { HelpOnePager } from "./helpOnePager/helpOnePager.component"; import {QuickTourModule} from "src/ui/quickTour/module"; +import { HowToCite } from "./howToCite/howToCite.component"; @NgModule({ imports: [ @@ -18,6 +19,7 @@ import {QuickTourModule} from "src/ui/quickTour/module"; declarations: [ AboutCmp, HelpOnePager, + HowToCite, ], exports: [ AboutCmp, diff --git a/src/ui/quickTour/constrants.ts b/src/ui/quickTour/constrants.ts index 38bb2d62b6443ac07caf3f8ff2a3217269f36a35..375ecc3f933a7e1d653e1c311148653a78d6dcf5 100644 --- a/src/ui/quickTour/constrants.ts +++ b/src/ui/quickTour/constrants.ts @@ -10,6 +10,7 @@ type TCustomPosition = { export interface IQuickTourData { order: number description: string + descriptionMd?: string tourPosition?: TPosition overwritePosition?: IQuickTourOverwritePosition overwriteArrow?: TemplateRef<any> | string diff --git a/src/util/pureConstant.service.ts b/src/util/pureConstant.service.ts index 51406f461875ce46e737629f8f5f87c0c64beeae..a309074629d1720ebc94a15e6e86be393089edf7 100644 --- a/src/util/pureConstant.service.ts +++ b/src/util/pureConstant.service.ts @@ -187,9 +187,9 @@ function getNehubaConfig(space: TSpaceFull) { export class PureContantService implements OnDestroy{ private subscriptions: Subscription[] = [] - public repoUrl = `https://github.com/HumanBrainProject/interactive-viewer` + public repoUrl = `https://github.com/FZJ-INM1-BDA/siibra-explorer` public supportEmailAddress = `support@ebrains.eu` - public docUrl = `https://interactive-viewer.readthedocs.io/en/latest/` + public docUrl = `https://siibra-explorer.readthedocs.io/` public showHelpSupportText: string = `Did you encounter an issue? Send us an email: <a target = "_blank" href = "mailto:${this.supportEmailAddress}">${this.supportEmailAddress}</a> diff --git a/src/viewerModule/viewerStateBreadCrumb/breadcrumb/breadcrumb.template.html b/src/viewerModule/viewerStateBreadCrumb/breadcrumb/breadcrumb.template.html index a80037b10ee223444d42bfe1f144872b82fa0fa2..e2d6f421be41011b5083aeaf1ccad24fd21b1858 100644 --- a/src/viewerModule/viewerStateBreadCrumb/breadcrumb/breadcrumb.template.html +++ b/src/viewerModule/viewerStateBreadCrumb/breadcrumb/breadcrumb.template.html @@ -187,6 +187,7 @@ fontSet="fas" fontIcon="fa-info-circle" iav-stop="click" + quick-tour iav-dataset-show-dataset-dialog [iav-dataset-show-dataset-dialog-name]="originDatainfo.name" [iav-dataset-show-dataset-dialog-description]="originDatainfo.description"