Merge pull request #93 from kiwix/92-phet-custom-app

PhET custom app

README.md

@@ -53,6 +53,8 @@ These key / values can be, but do not need to be included in the `info.json` fil
 
 - `bundle_id` - (optional) It should match to the bundle id set on the Apple Developer website for this app. If it's not set it will default to: "org.kiwix.custom.{brand_name}", where the brand name is the name of the folder, eg: "org.kiwix.custom.dwds".
 
+- `disable_immersive_reading` - optional (true| false) - if set to true, it will disable the immersive reading functionality on iOS, which is hiding the top / bottom nav bars while scrolling the web content. If the ZIM content is specific to a full screen experience (eg: PhET) it might be better to turn this feature off, so that the user navigation is not blocked (eg navigating back, search, bookmarks ect).
+
 - `zim_auth` - (optional) this is needed if standard http authentication is required to download the ZIM file. This should be set to **an environment variable name**, which will be resolved during build time. Make sure that the environment variable itself is set up properly before running the build process. **Do not place any credentials directly here, it's not safe, and won't work.**
 
 ## XCAssets file

phet/info.json

@@ -0,0 +1,14 @@
+{
+    "about_app_url": "https://www.kiwix.org/support",
+    "about_text": "Chemistry & Physics simulation",
+    "app_name": "PhET",
+    "app_store_id": "id6744251352",
+    "bundle_id": "org.kiwix.phet",
+    "development_team": "L7HWM3SP3L",
+    "disable_immersive_reading": true,
+    "settings_default_external_link_to": "alwaysLoad",
+    "settings_show_external_link_option": true,
+    "settings_show_search_snippet": false,
+    "uses_audio": false,
+    "zim_url": "http://localhost:8000/phet_mul_all_2025-03.zim"
+}

phet/phet.xcassets/AppIcon.appiconset/Contents.json

@@ -0,0 +1,74 @@
+{
+  "images" : [
+    {
+      "filename" : "phet_logo_1024.png",
+      "idiom" : "universal",
+      "platform" : "ios",
+      "size" : "1024x1024"
+    },
+    {
+      "filename" : "phet_logo_16.png",
+      "idiom" : "mac",
+      "scale" : "1x",
+      "size" : "16x16"
+    },
+    {
+      "filename" : "phet_logo_32 1.png",
+      "idiom" : "mac",
+      "scale" : "2x",
+      "size" : "16x16"
+    },
+    {
+      "filename" : "phet_logo_32.png",
+      "idiom" : "mac",
+      "scale" : "1x",
+      "size" : "32x32"
+    },
+    {
+      "filename" : "phet_logo_64.png",
+      "idiom" : "mac",
+      "scale" : "2x",
+      "size" : "32x32"
+    },
+    {
+      "filename" : "phet_logo_128.png",
+      "idiom" : "mac",
+      "scale" : "1x",
+      "size" : "128x128"
+    },
+    {
+      "filename" : "phet_logo_256.png",
+      "idiom" : "mac",
+      "scale" : "2x",
+      "size" : "128x128"
+    },
+    {
+      "filename" : "phet_logo_256 1.png",
+      "idiom" : "mac",
+      "scale" : "1x",
+      "size" : "256x256"
+    },
+    {
+      "filename" : "phet_logo_512.png",
+      "idiom" : "mac",
+      "scale" : "2x",
+      "size" : "256x256"
+    },
+    {
+      "filename" : "phet_logo_512 1.png",
+      "idiom" : "mac",
+      "scale" : "1x",
+      "size" : "512x512"
+    },
+    {
+      "filename" : "phet_logo_1024 1.png",
+      "idiom" : "mac",
+      "scale" : "2x",
+      "size" : "512x512"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

phet/phet.xcassets/Contents.json

@@ -0,0 +1,6 @@
+{
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

phet/phet.xcassets/GenericZimFile.imageset/Contents.json

@@ -0,0 +1,12 @@
+{
+  "images" : [
+    {
+      "filename" : "icon_128x128.png",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

phet/phet.xcassets/Other.imageset/Contents.json

@@ -0,0 +1,15 @@
+{
+  "images" : [
+    {
+      "filename" : "notebook.svg",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  },
+  "properties" : {
+    "preserves-vector-representation" : true
+  }
+}

phet/phet.xcassets/Other.imageset/notebook.svg

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 56.997 56.997" style="enable-background:new 0 0 56.997 56.997;" xml:space="preserve">
+<path style="fill:#424A60;" d="M46.002,51.997H7.998V0h38.003c1.655,0,2.997,1.342,2.997,2.997V49
+	C48.998,50.655,47.657,51.997,46.002,51.997z"/>
+<rect x="37.998" style="fill:#7383BF;" width="5" height="51.997"/>
+<g>
+	<rect x="7.998" y="17.007" style="fill:#25AE88;" width="30" height="18"/>
+	<rect x="42.998" y="17.007" style="fill:#25AE88;" width="6" height="18"/>
+</g>
+<polygon style="fill:#CC4B4C;" points="17.998,56.997 14.998,54.997 11.998,56.997 11.998,51.997 17.998,51.997 "/>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+<g>
+</g>
+</svg>

phet/phet.xcassets/StarAdd.imageset/Contents.json

@@ -0,0 +1,12 @@
+{
+  "images" : [
+    {
+      "filename" : "BookmarkAdded.png",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

phet/phet.xcassets/StarRemove.imageset/Contents.json

@@ -0,0 +1,12 @@
+{
+  "images" : [
+    {
+      "filename" : "BookmarkRemoved.png",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

phet/phet.xcassets/welcomeLogo.imageset/Contents.json

@@ -0,0 +1,16 @@
+{
+  "images" : [
+    {
+      "filename" : "phet_welcomeLogo.svg",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  },
+  "properties" : {
+    "preserves-vector-representation" : true,
+    "template-rendering-intent" : "original"
+  }
+}

phet/phet.xcassets/welcomeLogo.imageset/phet_welcomeLogo.svg

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg width="100%" height="100%" viewBox="0 0 388 388" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
+    <g transform="matrix(0.75,0,0,0.75,0,0)">
+        <g transform="matrix(0.789355,0,0,0.789355,77,-193.986)">
+            <g transform="matrix(1,0,0,1,0,460.063)">
+                <path d="M57.231,40.565L3.368,40.565C1.507,40.565 0,42.08 0,43.926L0,178.617C0,180.474 1.507,181.98 3.368,181.98L33.095,181.98C34.958,181.98 36.463,180.474 36.463,178.617L36.463,143.38C36.463,141.507 37.966,140.007 39.836,140.007L57.232,140.007C91.586,140.007 111.302,121.771 111.302,90.177C111.301,58.803 91.585,40.565 57.231,40.565M53.84,109.903L39.836,109.903C37.967,109.903 36.463,108.389 36.463,106.527L36.463,73.619C36.463,71.756 37.966,70.256 39.836,70.256L53.841,70.256C69.95,70.256 75.05,81.275 75.05,90.178C75.049,99.516 69.949,109.903 53.84,109.903" style="fill:rgb(130,204,234);fill-rule:nonzero;"/>
+            </g>
+            <g transform="matrix(1,0,0,1,0,460.063)">
+                <path d="M456.502,40.565L249.733,40.565C247.873,40.565 246.36,42.08 246.36,43.925L246.36,178.616C246.36,180.473 247.873,181.979 249.733,181.979L341.586,181.979C343.448,181.979 344.955,180.473 344.955,178.616L344.955,155.461C344.955,153.599 343.448,152.086 341.586,152.086L284.508,152.086C283.58,152.086 282.827,151.337 282.827,150.399L282.827,127.906C282.827,126.977 283.58,126.215 284.508,126.215L333.314,126.215C335.176,126.215 336.681,124.716 336.681,122.856L336.681,99.7C336.681,97.842 335.176,96.326 333.314,96.326L284.508,96.326C283.58,96.326 282.827,95.573 282.827,94.643L282.827,71.935C282.827,71.009 283.58,70.256 284.508,70.256L380.579,70.355C381.513,70.355 382.273,71.11 382.273,72.035L382.273,178.617C382.273,180.474 383.783,181.98 385.631,181.98L415.37,181.98C417.226,181.98 418.737,180.474 418.737,178.617L418.737,72.036C418.737,71.111 419.49,70.356 420.421,70.356L456.502,70.356C458.351,70.356 459.869,68.841 459.869,66.995L459.869,43.926C459.869,42.08 458.351,40.565 456.502,40.565" style="fill:rgb(130,204,234);fill-rule:nonzero;"/>
+            </g>
+            <g transform="matrix(1,0,0,1,0,460.063)">
+                <path d="M202.132,78.738C200.784,82.927 199.503,87.163 198.351,91.489C198.11,92.396 197.887,93.325 197.637,94.242C186.8,141.077 192.676,171.686 194.719,181.656C195.209,181.862 195.698,181.978 196.209,181.978L223.693,181.978C225.552,181.978 227.077,180.472 227.077,178.615L227.077,119.645C227.078,100.106 218.221,85.441 202.132,78.738" style="fill:rgb(254,225,5);fill-rule:nonzero;"/>
+            </g>
+            <g transform="matrix(1,0,0,1,0,460.063)">
+                <path d="M162.195,75.974L162.195,39.275C162.195,37.411 160.678,35.896 158.831,35.896L129.091,35.896C127.233,35.896 125.72,37.411 125.72,39.275L125.72,178.617C125.72,180.474 127.233,181.98 129.091,181.98L147.791,181.98C148.65,181.98 149.468,181.657 150.143,181.151C155.417,138.931 171.192,102.212 186.755,75.02C184.642,74.814 182.479,74.709 180.21,74.709C174.502,74.71 167.285,75.122 162.195,75.974" style="fill:rgb(254,225,5);fill-rule:nonzero;"/>
+            </g>
+            <g>
+                <g transform="matrix(1,0,0,1,0,460.063)">
+                    <path d="M179.288,27.301L200.146,34.849L226.986,12.495L206.322,36.955L228.645,44.822L236.692,-0.063L179.288,27.301Z" style="fill:rgb(254,225,5);fill-rule:nonzero;"/>
+                </g>
+                <g transform="matrix(1,0,0,1,0,460.063)">
+                    <path d="M208.376,49.312L207.505,39.298L215.209,42.073" style="fill:rgb(242,233,22);fill-rule:nonzero;"/>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>

src/info_parser.py

@@ -25,6 +25,7 @@ JSON_TO_PLIST_MAPPING = {
     "about_text": "CUSTOM_ABOUT_TEXT",
     "settings_default_external_link_to": "SETTINGS_DEFAULT_EXTERNAL_LINK_TO",
     "settings_show_search_snippet": "SETTINGS_SHOW_SEARCH_SNIPPET",
+    "disable_immersive_reading": "DISABLE_IMMERSIVE_READING",
     "settings_show_external_link_option": "SETTINGS_SHOW_EXTERNAL_LINK_OPTION"
 }