<commit_before>/*
====================
INSTRUCTIONS:
====================
1. Install the Photo Library plugin from Ionic Native if you're going to use the "allowSaving" option (see Usage notes below).
   To install run the following command in shell:
----
  npm install --save @ionic-native/photo-library && \
  ionic plugin add cordova-plugin-photo-library --variable PHOTO_LIBRARY_USAGE_DESCRIPTION="This is required by the app to save images."
----

Then import PhotoLibrary in the app.module.ts file and add it the "providers" section there.

2. Import ZoomPanDirective and FlipbookPage in your app.module.ts and add both of them to the "declarations" there.

3. Add FlipbookPage to the "entryComponents" of the app.module.ts file.

====================
USAGE:
====================
To open the flipbook just create a ModalController using FlipbookPage and pass the following NavParams:
- title: string (optional)
- activeIndex: number (optional)
- allowSharing: boolean (optional, false by default)
- allowSaving: boolean (optional, false by default)
- saveAlbumName: string (optional, "App Images" by default)
- images: FlipbookImage[] (required)

====================
EXAMPLE:
====================
this.modalCtrl.create(FlipbookPage, {
  title: 'Title', // optional
  activeIndex: 1, // optional
  allowSharing: true,
  allowSaving: true,
  saveAlbumName: 'My Album Name',
  images: [
    {
      url: '...', // required<commit_msg>added missing info to flipbook install instructions<commit_after>/*
====================
INSTRUCTIONS:
====================
1. Install the Photo Library plugin from Ionic Native, which is required by the "allowSaving" feature (see Usage below).
   To install run the following command in shell:
----
  npm install --save @ionic-native/photo-library && \
  ionic plugin add cordova-plugin-photo-library --variable PHOTO_LIBRARY_USAGE_DESCRIPTION="This is required by the app to save images."
----

Then import PhotoLibrary in the app.module.ts file and add it the "providers" section there.

2. Install the SocialSharing plugin form Ionic Native, which is required by the "allowSharing" feature (see Usage below):
----
  npm install --save @ionic-native/social-sharing
----

Then import SocialSharing in the app.module.ts file and add it the "providers" section there.

3. Import ZoomPanDirective and FlipbookPage in your app.module.ts and add both of them to the "declarations" there.

4. Add FlipbookPage to the "entryComponents" of the app.module.ts file.

====================
USAGE:
====================
To open the flipbook just create a ModalController using FlipbookPage and pass the following NavParams:
- title: string (optional)
- activeIndex: number (optional)
- allowSharing: boolean (optional, false by default)
- allowSaving: boolean (optional, false by default)
- saveAlbumName: string (optional, "App Images" by default)
- images: FlipbookImage[] (required)

====================
EXAMPLE:
====================
this.modalCtrl.create(FlipbookPage, {
  title: 'Title', // optional
  activeIndex: 1, // optional
  allowSharing: true,
  allowSaving: true,
  saveAlbumName: 'My Album Name',
  images: [
    {
      url: '...', // required
{'fraction_non_alphanumeric': 0.162586315128688, 'fraction_numerical': 0.002824858757062147, 'mean_word_length': 4.457191780821918, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4494368', 'n_tokens_mistral': 908, 'n_tokens_neox': 868, 'n_words': 345}