Skip to content

Commit

Permalink
V1.5.1
Browse files Browse the repository at this point in the history
  • Loading branch information
skitterm committed Sep 27, 2017
1 parent 5ad93bf commit 493a148
Show file tree
Hide file tree
Showing 144 changed files with 1,340 additions and 1,006 deletions.
5 changes: 4 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ deploy/
build/
node_modules/

# Needed for CI
src/lib/

#################
## Eclipse
#################
Expand Down Expand Up @@ -196,7 +199,7 @@ $RECYCLE.BIN/
# Packages
*.egg
*.egg-info
#dist/
dist/
build/
eggs/
parts/
Expand Down
18 changes: 9 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Story Map Cascade℠ app lets you combine narrative text with maps, images,
[Download](http://links.esri.com/storymaps/story_map_cascade_zip) |
[Cascade page on Esri Story Maps website](https://storymaps.arcgis.com/en/app-list/cascade/)

**Latest release is version 1.4.2**, if you want to be informed of new releases, we recommend you watch this repository ([see GitHub help](https://help.github.com/articles/watching-repositories)). See the [release page](https://github.com/Esri/story-map-cascade/releases) for release notes.
**Latest release is version 1.5.1**, if you want to be informed of new releases, we recommend you watch this repository ([see GitHub help](https://help.github.com/articles/watching-repositories)). See the [release page](https://github.com/Esri/story-map-cascade/releases) for release notes.

## Help content

Expand All @@ -30,14 +30,14 @@ This repository provides the application source code for developers who want to
For more information about the application, including a gallery of examples and a step-by-step tutorial, please see the [Cascade page](https://storymaps.arcgis.com/en/app-list/cascade/) on the [Esri Story Maps website](https://storymaps.arcgis.com/).

## Instructions
First create your Cascade story in ArcGIS using the [step-by-step tutorial](https://storymaps.arcgis.com/en/app-list/cascade/tutorial/).
First, create your Cascade story in ArcGIS using the [step-by-step tutorial](https://storymaps.arcgis.com/en/app-list/cascade/tutorial/).
Once your story is ready, you have to find its ID in ArcGIS. The ID is a 32 character string that you will find in your web browser's address bar when you are viewing your story.

![Screenshot](https://cloud.githubusercontent.com/assets/994078/16124454/e26566ba-33a3-11e6-9be1-8af3f9f86113.png)

1. [Download the application](http://links.esri.com/storymaps/story_map_cascade_zip)
2. Deploy the application on your webserver. See [FAQ](#how-to-deploy-the-application-on-a-web-server) for details
3. Edit index.html, find the configuration section on line 44 and paste in your application ID
3. Edit index.html, find the configuration section on line 47 and paste in your application ID
4. Navigate to index.html (e.g., `http://127.0.0.1/Cascade/index.html`)

You can continue to use the builder in ArcGIS to modify your story.
Expand Down Expand Up @@ -86,7 +86,7 @@ When the story is hosted in ArcGIS Online or ArcGIS Enterprise, users who don't

When the story is hosted on your web server, by default an authentication dialog will appear inside the application. But we recommend that you configure the application to use OAuth. OAuth 2.0 based authentication is available for ArcGIS Online users with developer or organizational accounts and ArcGIS Enterprise users. Follow [this procedure](http://doc.arcgis.com/en/arcgis-online/share-maps/add-items.htm#ESRI_SECTION1_0D1B620254F745AE84F394289F8AF44B) to add and register an application to get an OAuth application ID. Once you have that application, open `index.html`, locate the `configOptions` section and fill the `oAuthAppId` property.

If you are using secured services but don't want users to have to authenticate, you can use a proxy to store the username/password to be used, see [Working with Proxy Services](https://developers.arcgis.com/authentication/working-with-proxies/#selfhosted-proxy-service), and add a proxy rules to specify what services need to use the proxy by editing `PROXY_RULES` in `app/config.js`.
If you are using secured services but don't want users to have to authenticate, you can use a proxy to store the username/password to be used, see [Working with Proxy Services](https://developers.arcgis.com/authentication/working-with-proxies/#selfhosted-proxy-service), and add proxy rules to specify what services need to use the proxy by editing `PROXY_RULES` in `app/config.js`.

### Deployment
Deploying a Cascade story requires use of ArcGIS Online or ArcGIS Enterprise. The Cascade content must be created using the Cascade builder and will live in a Web Application Item.
Expand All @@ -103,7 +103,7 @@ The images, audio, and videos that you include in your story using the builder a
Yes, Cascade is included with ArcGIS Enterprise starting at version 10.5.1.

#### Can I use the builder if I host the app on my own web server?
Yes, when the story is configured with an application ID, adding the URL parameter 'edit' will open the builder. You will be prompted for user authentication.
Yes, when the story is configured with an application ID, adding the URL parameter `edit` will open the builder. You will be prompted for user authentication.

#### How do I deploy the application on a web server?
If you are not familiar with web servers, here are some solutions:
Expand Down Expand Up @@ -132,7 +132,7 @@ In addition to the configuration offered by the builder, the file `app/config.js

Cascade currently offers a light and dark theme and the option to choose between four different fonts. Other look and feel customizations can be done using the [regular application download](http://links.esri.com/storymaps/story_map_cascade_zip) and including the css/html overrides directly into `index.html`. A `style` tag is already present for you in `index.html` (search for `/* CUSTOM CSS RULES */`).

As the application Javascript and CSS are minified, **we don't recommend that you directely edit those files** (e.g. `viewer-min.css`, `viewer-min.js`, ...). In addition to being hard to edit, this will make application update complex for you.
As the application Javascript and CSS are minified, **we don't recommend that you directly edit those files** (e.g. `viewer-min.css`, `viewer-min.js`, ...). In addition to being hard to edit, this will make application update complex for you.

If you want to change the behavior of one functionality or want to add new one, follow the [developer guide](#developer-guide) below.

Expand All @@ -146,11 +146,11 @@ It requires knowledge of HTML, Javascript and CSS languages.
For more infomation about using and customizing Esri's Storytelling Apps follow the [Story Maps Developers' Corner](https://developerscorner.storymaps.arcgis.com).

### Application life cycle
Cascade fires events that allow customization with loose integration. This mean that you don't need to understand the application internals to implement simple extensions.
Cascade fires events that allow customization with loose integration. This means that you don't need to understand the application internals to implement simple extensions.

To try those events, look in the file `src/app/custom-scripts.js`.

```
```javascript
require(['dojo/topic'], function(topic) {
/*
* Custom Javascript to be executed while the application is initializing goes here
Expand Down Expand Up @@ -178,7 +178,7 @@ require(['dojo/topic'], function(topic) {
### Developer helpers
In addition to the events described above, the story data, configuration and useful helpers functions can be accessed through the global variable `app`.

```
```javascript
console.log("Story title", app.Controller.getStoryTitle());
console.log("Sections objects", app.data.sections);
console.log("First section bookmark", app.data.sections[0].getBookmark());
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Storymaps-Cascade",
"version": "1.4.2",
"version": "1.5.1",
"description": "The Story Map Cascade app lets you combine narrative text with maps, images, and multimedia content in an engaging, full-screen scrolling experience",
"license": "Apache-2.0",
"repository": {
Expand Down
43 changes: 23 additions & 20 deletions src/app/storymaps/common/Core.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ define([

IdentityManager.registerOAuthInfos([info]);

IdentityManager.checkSignInStatus(info.portalUrl).then(
IdentityManager.checkSignInStatus(info.portalUrl + '/sharing/rest').then(
function() {
// User has signed-in using oAuth
if (! builder) {
Expand All @@ -364,6 +364,8 @@ define([
);
}
else {
//if not using oauth, tell API to grab token from the cookie to use later (avoid login loops). We already call it if you are using oauth.
IdentityManager.checkSignInStatus('https:' + app.indexCfg.sharingurl.split('/sharing/')[0] + '/sharing/rest');
initStep2();
}
});
Expand Down Expand Up @@ -477,25 +479,26 @@ define([
app.userCanEdit = CommonHelper.userIsAppOwner();

// Prevent app from accessing the cookie in viewer when user is not the owner
if (! app.isInBuilder && ! app.userCanEdit) {
if (! document.__defineGetter__) {
Object.defineProperty(document, 'cookie', {
get: function() {
return '';
},
set: function() {
return true;
}
});
}
else {
document.__defineGetter__('cookie', function() {
return '';
});
document.__defineSetter__('cookie', function() {
});
}
}
//
// if (! app.isInBuilder && ! app.userCanEdit) {
// if (! document.__defineGetter__) {
// Object.defineProperty(document, 'cookie', {
// get: function() {
// return '';
// },
// set: function() {
// return true;
// }
// });
// }
// else {
// document.__defineGetter__('cookie', function() {
// return '';
// });
// document.__defineSetter__('cookie', function() {
// });
// }
// }

if (app.indexCfg.authorizedOwners && app.indexCfg.authorizedOwners.length > 0 && app.indexCfg.authorizedOwners[0]) {
var owner = itemRq.owner,
Expand Down
12 changes: 6 additions & 6 deletions src/app/storymaps/common/_resources/nls/ar/media.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@ define({
"imageAndVideo": "رابط لصورة أو مقطع فيديو على الويب"
},
"linkText": {
"imageOnly": "في الصندوق أعلاه، يمكنك الربط بالصور مباشرةً",
"imageAndVideo1": "في الصندوق أعلاه، يمكن لصق الارتباطات أو كود iframe الخاصين بمقاطع الفيديو من ${YouTube} و${Vimeo}.",
"imageAndVideo2": "يمكنك أيضًا الربط بالصور مباشرةً.",
"imageVideoWebpage1": "في الصندوق أعلاه، يمكن لصق الارتباطات أو كود iframe الخاصين بمقاطع الفيديو من ${YouTube} و${Vimeo}.",
"imageVideoWebpage2": "يمكنك أيضًا الربط بالصور أو صفحات الويب أو تطبيقات الويب مباشرةً.",
"ender": "استخدم ارتباطات (https) الآمنة إذا أمكن."
"imageOnly": "في الصندوق أعلاه، يمكنك الربط بصورة مباشرةً.",
"imageAndVideo1": "في الصندوق أعلاه، يمكنك لصق رابط أو كود iframe خاص بفيديو على ${YouTube} أو ${Vimeo}",
"imageAndVideo2": "يمكنك أيضًا الربط بصورة مباشرةً.",
"imageVideoWebpage1": "في الصندوق أعلاه، يمكنك لصق رابط أو كود iframe خاص بمحتوى ويب، مثل مخطط ديناميكي أو فيديو على ${YouTube} أو ${Vimeo}",
"imageVideoWebpage2": "يمكنك أيضًا الربط بصورة أو فيديو أو ملف صوتي أو صفحة ويب أو تطبيق ويب مباشرةً.",
"ender": "استخدام روابط (https) الآمنة دائمًا. إذا لم يكن المحتوى يدعم https، أضف رابطًا إليه في نَص القصة حتى يمكن للقُرَّاء عرضه في علامة مستعرض جديدة."
},
"embedProtocol": {
"embedProtocolLabel": "تحميل الصفحة عبر اتصال آمن (https)",
Expand Down
12 changes: 6 additions & 6 deletions src/app/storymaps/common/_resources/nls/bs/media.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@ define({
"imageAndVideo": "Poveznica na sliku ili videozapis na webu"
},
"linkText": {
"imageOnly": "U prethodnom okviru možete staviti poveznicu izravno na fotografije.",
"imageAndVideo1": "U prethodnom okviru možete zalijepiti poveznice ili koda iframea za videozapise s usluga ${YouTube} i ${Vimeo}.",
"imageAndVideo2": "Također možete stavit poveznicu izravno na fotografije.",
"imageVideoWebpage1": "U prethodnom okviru možete zalijepiti poveznice ili koda iframea za videozapise s usluga ${YouTube} i ${Vimeo}.",
"imageVideoWebpage2": "Također možete staviti poveznicu izravno na fotografije, web-stranice ili web-aplikacije.",
"ender": "Kada je moguće, upotrijebite, sigurne (https) poveznice."
"imageOnly": "U prethodnom okviru možete staviti poveznicu izravno na fotografiju.",
"imageAndVideo1": "U prethodnom okviru možete zalijepiti poveznicu ili kod iframea za videozapis s usluga ${YouTube} ili ${Vimeo}.",
"imageAndVideo2": "Također možete stavit poveznicu izravno na fotografiju.",
"imageVideoWebpage1": "U prethodnom okviru možete zalijepiti poveznicu ili kod iframea za web-sadržaj kao što je dinamični grafikon ili videozapis s usluga ${YouTube} ili ${Vimeo}.",
"imageVideoWebpage2": "Također možete staviti poveznicu izravno na fotografiju, videozapis, zvučnu datoteku, web-stranicu ili web-app.",
"ender": "Uvijek se koristite sigurnim (https) poveznicama. Ako vaš sadržaj ne podržava https, dodajte mu poveznicu u tekstu priče tako da ga čitatelji mogu prikazati u novoj kartici preglednika."
},
"embedProtocol": {
"embedProtocolLabel": "Učitajte stranicu preko sigurne veze (https)",
Expand Down
12 changes: 6 additions & 6 deletions src/app/storymaps/common/_resources/nls/cs/media.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@ define({
"imageAndVideo": "Propojit s obrázkem nebo videem na webu"
},
"linkText": {
"imageOnly": "V poli výše můžete vytvořit propojení přímo na fotografie.",
"imageAndVideo1": "V poli výše můžete vložit propojení nebo kód iframe pro videa ze služeb ${YouTube} a ${Vimeo}.",
"imageAndVideo2": "Můžete také vytvořit propojení přímo na fotografie.",
"imageVideoWebpage1": "V poli výše můžete vložit propojení nebo kód iframe pro videa ze služeb ${YouTube} a ${Vimeo}.",
"imageVideoWebpage2": "Můžete také vložit propojení přímo na fotografie, webové stránky nebo webové aplikace.",
"ender": "Je-li to možné, použijte zabezpečená propojení (https)."
"imageOnly": "V poli výše můžete vložit odkaz přímo na fotografii.",
"imageAndVideo1": "V poli výše můžete vložit odkaz nebo kód iframe pro videa na ${YouTube} nebo ${Vimeo}.",
"imageAndVideo2": "Můžete se také odkazovat přímo na fotografie.",
"imageVideoWebpage1": "V poli výše můžete vložit odkaz nebo kód iframe pro webový obsah jako dynamický graf nebo video na ${YouTube} nebo ${Vimeo}.",
"imageVideoWebpage2": "Můžete se také odkazovat přímo na fotografii, video, audio soubor, webovou stránku nebo webovou aplikaci.",
"ender": "Vždy používejte zabezpečené připojení (odkazy s https). Pokud váš obsah nepodporuje https, přidejte k němu odkaz v textu vašeho příběhu, aby si jej čtenáři mohli zobrazit v nové záložce prohlížeče."
},
"embedProtocol": {
"embedProtocolLabel": "Nahrát stránku přes zabezpečené připojení (https)",
Expand Down
12 changes: 6 additions & 6 deletions src/app/storymaps/common/_resources/nls/da/media.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@ define({
"imageAndVideo": "Link til et billede eller en video på internettet"
},
"linkText": {
"imageOnly": "I boksen ovenfor kan du linke direkte til fotos.",
"imageAndVideo1": "I boksen ovenfor kan du indsætte links eller iframe-kode til videoer på ${YouTube} og ${Vimeo}.",
"imageAndVideo2": "Du kan også linke direkte til fotos.",
"imageVideoWebpage1": "I boksen ovenfor kan du indsætte links eller iframe-kode til videoer på ${YouTube} og ${Vimeo}.",
"imageVideoWebpage2": "Du kan også linke direkte til fotos, websider eller webapplikationer.",
"ender": "Brug sikre (https) links, når det er muligt."
"imageOnly": "I boksen ovenfor kan du linke direkte til et foto.",
"imageAndVideo1": "I boksen ovenfor kan du indsætte et link eller en iframe-kode til en video på ${YouTube} og ${Vimeo}.",
"imageAndVideo2": "Du kan også linke direkte til et foto.",
"imageVideoWebpage1": "I boksen ovenfor kan du indsætte et link eller en iframe-kode til webindhold, såsom et dynamisk diagram eller en video på ${YouTube} og ${Vimeo}.",
"imageVideoWebpage2": "Du kan også linke direkte til et foto, en video, en lydfil, en webside eller en webapplikation.",
"ender": "Brug altid sikre (https)-links. Hvis dit indhold ikke understøtter https, skal du tilføje et link til det i din histories tekst, så læserne kan få indholdet vist i en ny browserfane."
},
"embedProtocol": {
"embedProtocolLabel": "Indlæs side via en sikker forbindelse (https)",
Expand Down
12 changes: 6 additions & 6 deletions src/app/storymaps/common/_resources/nls/de/media.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@ define({
"imageAndVideo": "Link zu einem Bild oder Video im Web"
},
"linkText": {
"imageOnly": "Im Feld oben können Sie einen direkten Link zu Fotos bereitstellen.",
"imageAndVideo1": "Im Feld oben können Sie Links oder iframe-Code für Videos aus ${YouTube} und ${Vimeo} einfügen.",
"imageAndVideo2": "Sie können auch direkte Links zu Fotos bereitstellen.",
"imageVideoWebpage1": "Im Feld oben können Sie Links oder iframe-Code für Videos aus ${YouTube} und ${Vimeo} einfügen.",
"imageVideoWebpage2": "Sie können auch direkte Links zu Fotos, Webseiten oder Webanwendungen bereitstellen.",
"ender": "Verwenden Sie nach Möglichkeit sichere Links (HTTPS)."
"imageOnly": "Im Feld oben können Sie einen direkten Link zu einem Foto bereitstellen.",
"imageAndVideo1": "Im Feld oben können Sie einen Link oder iframe-Code für ein Video aus ${YouTube} oder ${Vimeo} einfügen.",
"imageAndVideo2": "Sie können auch einen direkten Link zu einem Foto bereitstellen.",
"imageVideoWebpage1": "Im Feld oben können Sie einen Link oder iframe-Code für Webinhalt wie ein dynamisches Diagramm oder ein Video aus ${YouTube} oder ${Vimeo} einfügen.",
"imageVideoWebpage2": "Sie können auch einen direkten Link zu einem Foto, einem Video, einer Audiodatei, einer Webseite oder einer Web-App bereitstellen.",
"ender": "Verwenden Sie immer sichere Links (HTTPS). Wenn der Inhalt HTTPS nicht unterstützt, fügen Sie im Text der Story einen entsprechenden Link hinzu, damit die Leser ihn auf einer neuen Browser-Registerkarte anzeigen können."
},
"embedProtocol": {
"embedProtocolLabel": "Seite über eine sichere Verbindung (HTTPS) laden",
Expand Down
Loading

0 comments on commit 493a148

Please sign in to comment.