@liascript/exporter 2.2.0--0.10.1 → 2.3.0--0.10.1

package/README.md

@@ -21,41 +21,39 @@ At the moment this is a simple command-line tool based on NodeJS, thus you will
 have to install NodeJS first, which contains also `npm` the Node Package
 Manager. You can directly download the installer for your system from:
 
-https://nodejs.org/en/download/
+<https://nodejs.org/en/download/>
 
 Afterwards you can open your terminal and type in the following command, this
 will install the LiaScript-Exporter as a global application on your system.
 
-**Install from npm:**
+__Install from npm:__
 
 ``` bash
-$ npm install -g --verbose @liascript/exporter
+npm install -g --verbose @liascript/exporter
 ```
 
 Depending on your configuration, you might need to run this command with root
 privileges. In my case on Linux it is simply:
 
 ``` bash
-$ sudo npm install -g --verbose @liascript/exporter
+sudo npm install -g --verbose @liascript/exporter
 ```
 
-**Install from github:** Similar to the code above...
-
+__Install from github:__ Similar to the code above...
 
 ``` bash
-$ npm install -g --verbose https://github.com/liaScript/LiaScript-Exporter
+npm install -g --verbose https://github.com/liaScript/LiaScript-Exporter
 ```
 
 Depending on your configuration, you might need to run this command with root
 privileges. In my case on Linux it is simply:
 
 ``` bash
-$ sudo npm install -g --verbose https://github.com/liaScript/LiaScript-Exporter
+sudo npm install -g --verbose https://github.com/liaScript/LiaScript-Exporter
 ```
 
 On Windows you might need to run the terminal with administrator-privileges.
 
-
 ## Basic usage
 
 If you have installed the package, you can now use `liaex` or
@@ -93,6 +91,15 @@ WEB settings:
 --web-indexeddb            This will allow to store data within the browser using indexeddb, you can optionally pass a unique key (by default one is generated randomly).
 --web-zip                  By default the result is not zipped, you can change this with this parameter.
 
+Android settings:
+
+--android-sdk              Specify sdk.dir which is required for building.
+--android-appName          Name of the App (Main-title is used as default).
+--android-appId            Required to identify your App reverse url such as io.github.liascript
+--android-icon             Optional icon with 1024x1024 px
+--android-splash           Optional splash image with 2732x2732 px
+--android-splashDuration   Duration for splash-screen default 0 milliseconds
+
 PDF settings:
 
 --pdf-stylesheet           Inject an local CSS for changing the appearance.
@@ -156,12 +163,12 @@ number of you course as well as the current date.
 > only support to store location information, all states of quizzes, surveys, etc.
 > will be lost after reload.
 >
-> Better use **SCORM2004** as output
+> Better use __SCORM2004__ as output
 
 __Text 2 Speech `--key`__
 
 If you want to use text2speech, you will have to register your website (where
-the scorm package will be served) at https://responsivevoice.org/ ... it is free
+the scorm package will be served) at <https://responsivevoice.org/> ... it is free
 for educational and non commercial purposes. After your registration, you will
 get a key in the format of `KluQksUs`. To inject this key into your package,
 simly add the key as a paramter:
@@ -197,7 +204,6 @@ __`--scrom-organization`__
 This parameter simply sets the organization parameter in your SCORM
 `imsmanifest` file. All other parameters are taken from the course
 
-
 __`--scorm-iframe`__
 
 Some LMS like ILIAS or OpenOlat seem to have problems with the required
@@ -290,6 +296,7 @@ archiver has been finalized and the output file descriptor has closed.
 $ ls
 .. course.zip ..
 ```
+
 ### WEB
 
 This format will generate an autonomous & standalone web-project that can be uploaded
@@ -332,6 +339,91 @@ updating description ...
 updating logo ...
 ```
 
+### Android
+
+To generate an APK project of your course, you will have to download the
+[Android SDK](https://developer.android.com/studio) at first and provide the path
+via the option `--android-sdk`. Additionally you will have to define an `appId`
+via `--android-appId`, which is in most cases an unique URL (in reverse order)
+that is pointing to your website/project. This export uses
+[capacitorjs](https://capacitorjs.com) to pack the entire LiaScript runtime
+environment and your resources into one installable Android apk.
+
+``` shell
+$ liaex -f android \
+  -i ../LiaBooks/Arbeitsbuch-Prolog/README.md \
+  --android-sdk /home/andre/Android/Sdk \
+  --android-appId io.github.liascript.arbeitsbuch-prolog
+...
+../LiaBooks/Arbeitsbuch-Prolog
+../LiaBooks/Arbeitsbuch-Prolog/img
+../LiaBooks/Arbeitsbuch-Prolog/img/turtle.png
+...
+added 401 packages, and audited 402 packages in 34s
+
+23 packages are looking for funding
+  run `npm fund` for details
+
+5 moderate severity vulnerabilities
+
+...
+✔ Adding native android project in android in 37.13ms
+✔ add in 38.39ms
+✔ Copying web assets from dist to android/app/src/main/assets/public in 97.33ms
+✔ Creating capacitor.config.json in android/app/src/main/assets in 207.60μs
+✔ copy android in 100.41ms
+✔ Updating Android plugins in 592.70μs
+[info] Found 1 Capacitor plugin for android:
+       @capacitor-community/text-to-speech@1.1.2
+✔ update android in 18.04ms
+✔ Syncing Gradle in 143.57μs
+[success] android platform added!
+Follow the Developer Workflow guide to get building:
+https://capacitorjs.com/docs/basics/workflow
+📦  Capacitor Resources v2.0.5
+-----------------------------
+
+Checking files and directories...
+ ✓  Processing files for: android
+ ✓  Icon file ok (1024x1024)
+ ✓  Splash file ok (2732x2732)
+ ✓  Output directory ok (resources)
+
+Generating files...
+ ✓  Generated icon files for android
+ ✓  Generated splash files for android
+ ✓  Successfully generated all files
+Root path: /tmp/lia202227-209284-1q2g2zd.tn3x
+
+----------------------------------------------
+
+📦  Capacitor resources generated successfully!
+...
+Currently detected usages in: root project 'android', project ':app', project ':capacitor-android', ...
+> Task :app:preBuild UP-TO-DATE
+> Task :app:preDebugBuild UP-TO-DATE
+> Task :capacitor-android:preBuild UP-TO-DATE
+> Task :capacitor-android:preDebugBuild UP-TO-DATE
+> Task :capacitor-android:compileDebugAidl NO-SOURCE
+
+Deprecated Gradle features were used in this build, making it incompatible with Gradle 8.0.
+Use '--warning-mode all' to show the individual deprecation warnings.
+See https://docs.gradle.org/7.0/userguide/command_line_interface.html#sec:command_line_warnings
+
+BUILD SUCCESSFUL in 3s
+103 actionable tasks: 103 executed
+
+DONE
+
+$ ls 
+... output.apk ...
+```
+
+> __Note:__ To achieve better performance and offline capabilities, try to add
+> all resources as local ones to your project (i.e. images, audio,scripts, css).
+
+__Still a bit experimental__
+
 ### PDF
 
 For printing out courses to PDF this package uses
@@ -345,9 +437,8 @@ as screenshots, which provide a link to the original resource.
 This format has a `--pdf-preview` mode, which allows you to inspect your course,
 which works also with https inputs.
 
-
 ``` shell
-$ liaex --format pdf --pdf-preview -i https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_ProzeduraleProgrammierung/master/08_Objekte.md
+liaex --format pdf --pdf-preview -i https://raw.githubusercontent.com/TUBAF-IfI-LiaScript/VL_ProzeduraleProgrammierung/master/08_Objekte.md
 
 ```
 
@@ -397,7 +488,6 @@ $ liaex --format pdf \
 depending on the size of the course, this can take a while, please be patient...
 ```
 
-
 __`--pdf-timeout`__
 
 You have to be aware, that the PDF generation can be quite time consuming
@@ -414,19 +504,19 @@ $ liaex --format pdf \
 
 depending on the size of the course, this can take a while, please be patient...
 ```
+
 ## TODOs & Contributions
 
 * Further exporter
 
-  - AICC
-  - xAPI
-  - ePub
+  * AICC
+  * xAPI
+  * ePub
 
 * Integration into the Atom IDE
 
 * GitHub actions to automate building during push ...
 
-
 ### Custom extensions
 
 If you are interested in creating integrations for other systems by your own,
@@ -437,15 +527,12 @@ Actually it is a simple class that inherits all methods from `Base/Connector`,
 which have to be changed in accordance to you system.
 __I will have to document this__
 
-
 ## LMS Support List
 
-
 Most of the data is taken from:
 
-* https://www.ispringsolutions.com/supported-lms
-* https://en.wikipedia.org/wiki/List_of_learning_management_systems
-
+* <https://www.ispringsolutions.com/supported-lms>
+* <https://en.wikipedia.org/wiki/List_of_learning_management_systems>
 
 | LMS                                | SCORM 1.2 | SCORM 2004 | xAPI    | AICC    | CMI-5 | IMS  | License     |
 | ---------------------------------- | --------- | ---------- | ------- | ------- | ----- | ---- | ----------- |

package/android/.idea/compiler.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="CompilerConfiguration">
+    <bytecodeTargetLevel target="11" />
+  </component>
+</project>

package/android/.idea/jarRepositories.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="RemoteRepositoriesConfiguration">
+    <remote-repository>
+      <option name="id" value="central" />
+      <option name="name" value="Maven Central repository" />
+      <option name="url" value="https://repo1.maven.org/maven2" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="jboss.community" />
+      <option name="name" value="JBoss Community repository" />
+      <option name="url" value="https://repository.jboss.org/nexus/content/repositories/public/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="BintrayJCenter" />
+      <option name="name" value="BintrayJCenter" />
+      <option name="url" value="https://jcenter.bintray.com/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="Google" />
+      <option name="name" value="Google" />
+      <option name="url" value="https://dl.google.com/dl/android/maven2/" />
+    </remote-repository>
+    <remote-repository>
+      <option name="id" value="MavenRepo" />
+      <option name="name" value="MavenRepo" />
+      <option name="url" value="https://repo.maven.apache.org/maven2/" />
+    </remote-repository>
+  </component>
+</project>

package/android/.idea/misc.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" default="true" project-jdk-name="1.8" project-jdk-type="JavaSDK">
+    <output url="file://$PROJECT_DIR$/build/classes" />
+  </component>
+  <component name="ProjectType">
+    <option name="id" value="Android" />
+  </component>
+</project>

package/android/.idea/runConfigurations.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="RunConfigurationProducerService">
+    <option name="ignoredProducers">
+      <set>
+        <option value="com.android.tools.idea.compose.preview.runconfiguration.ComposePreviewRunConfigurationProducer" />
+      </set>
+    </option>
+  </component>
+</project>

package/android/app/build.gradle

@@ -0,0 +1,51 @@
+apply plugin: 'com.android.application'
+
+android {
+    compileSdkVersion rootProject.ext.compileSdkVersion
+    defaultConfig {
+        applicationId "org.liascript.app"
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        aaptOptions {
+             // Files and dirs to omit from the packaged assets dir, modified to accommodate modern web apps.
+             // Default: https://android.googlesource.com/platform/frameworks/base/+/282e181b58cf72b6ca770dc7ca5f91f135444502/tools/aapt/AaptAssets.cpp#61
+            ignoreAssetsPattern '!.svn:!.git:!.ds_store:!*.scc:.*:!CVS:!thumbs.db:!picasa.ini:!*~'
+        }
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+}
+
+repositories {
+    flatDir{
+        dirs '../capacitor-cordova-android-plugins/src/main/libs', 'libs'
+    }
+}
+
+dependencies {
+    implementation fileTree(include: ['*.jar'], dir: 'libs')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation project(':capacitor-android')
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+    implementation project(':capacitor-cordova-android-plugins')
+}
+
+apply from: 'capacitor.build.gradle'
+
+try {
+    def servicesJSON = file('google-services.json')
+    if (servicesJSON.text) {
+        apply plugin: 'com.google.gms.google-services'
+    }
+} catch(Exception e) {
+    logger.info("google-services.json not found, google-services plugin not applied. Push Notifications won't work")
+}

package/android/app/capacitor.build.gradle

@@ -0,0 +1,19 @@
+// DO NOT EDIT THIS FILE! IT IS GENERATED EACH TIME "capacitor update" IS RUN
+
+android {
+  compileOptions {
+      sourceCompatibility JavaVersion.VERSION_1_8
+      targetCompatibility JavaVersion.VERSION_1_8
+  }
+}
+
+apply from: "../capacitor-cordova-android-plugins/cordova.variables.gradle"
+dependencies {
+
+
+}
+
+
+if (hasProperty('postBuildExtras')) {
+  postBuildExtras()
+}

package/android/app/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

package/android/app/src/androidTest/java/com/getcapacitor/myapp/ExampleInstrumentedTest.java

@@ -0,0 +1,26 @@
+package com.getcapacitor.myapp;
+
+import static org.junit.Assert.*;
+
+import android.content.Context;
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+import androidx.test.platform.app.InstrumentationRegistry;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
+ */
+@RunWith(AndroidJUnit4.class)
+public class ExampleInstrumentedTest {
+
+    @Test
+    public void useAppContext() throws Exception {
+        // Context of the app under test.
+        Context appContext = InstrumentationRegistry.getInstrumentation().getTargetContext();
+
+        assertEquals("com.getcapacitor.app", appContext.getPackageName());
+    }
+}

package/android/app/src/main/AndroidManifest.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="org.liascript.app">
+
+    <application
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/AppTheme">
+
+        <activity
+            android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|smallestScreenSize|screenLayout|uiMode"
+            android:name="org.liascript.app.MainActivity"
+            android:label="@string/title_activity_main"
+            android:theme="@style/AppTheme.NoActionBarLaunch"
+            android:launchMode="singleTask">
+
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+
+        </activity>
+
+        <provider
+            android:name="androidx.core.content.FileProvider"
+            android:authorities="${applicationId}.fileprovider"
+            android:exported="false"
+            android:grantUriPermissions="true">
+            <meta-data
+                android:name="android.support.FILE_PROVIDER_PATHS"
+                android:resource="@xml/file_paths"></meta-data>
+        </provider>
+    </application>
+
+    <!-- Permissions -->
+
+    <uses-permission android:name="android.permission.INTERNET" />
+</manifest>

package/android/app/src/main/assets/capacitor.config.json

@@ -0,0 +1,6 @@
+{
+	"appId": "org.liascript.app",
+	"appName": "LiaScript",
+	"webDir": "dist/assets/indexeddb",
+	"bundledWebRuntime": false
+}

package/android/app/src/main/assets/capacitor.plugins.json

@@ -0,0 +1 @@
+[]

package/android/app/src/main/res/drawable/ic_launcher_background.xml

@@ -0,0 +1,170 @@
+<?xml version="1.0" encoding="utf-8"?>
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="108dp"
+    android:height="108dp"
+    android:viewportHeight="108"
+    android:viewportWidth="108">
+    <path
+        android:fillColor="#26A69A"
+        android:pathData="M0,0h108v108h-108z" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M9,0L9,108"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M19,0L19,108"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M29,0L29,108"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M39,0L39,108"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M49,0L49,108"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M59,0L59,108"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M69,0L69,108"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M79,0L79,108"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M89,0L89,108"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M99,0L99,108"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M0,9L108,9"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M0,19L108,19"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M0,29L108,29"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M0,39L108,39"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M0,49L108,49"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M0,59L108,59"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M0,69L108,69"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M0,79L108,79"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M0,89L108,89"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M0,99L108,99"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M19,29L89,29"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M19,39L89,39"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M19,49L89,49"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M19,59L89,59"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M19,69L89,69"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M19,79L89,79"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M29,19L29,89"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M39,19L39,89"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M49,19L49,89"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M59,19L59,89"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M69,19L69,89"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+    <path
+        android:fillColor="#00000000"
+        android:pathData="M79,19L79,89"
+        android:strokeColor="#33FFFFFF"
+        android:strokeWidth="0.8" />
+</vector>