improve: helper with more descriptions

Author: andre-dietrich

dist/index.js

@@ -8,6 +8,16 @@ const { exec } = require('child_process')
 export function help() {
   console.log('\n', COLOR.heading('Android settings:'), '\n')
 
+  console.log(
+    COLOR.italic(
+      'Android export generates a native Android application (.apk) from your LiaScript course using Capacitor. This requires the Android SDK to be installed on your system.\n'
+    )
+  )
+  console.log('Learn more:')
+  console.log('- Capacitor:   https://capacitorjs.com/')
+  console.log('- Android SDK: https://developer.android.com/studio')
+  console.log('')
+
   COLOR.command(
     null,
     '--android-sdk',

src/export/android.ts

@@ -6,16 +6,32 @@ const path = require('path')
 const fs = require('fs-extra')
 
 export function help() {
-  console.log('\n', COLOR.heading('IMS settings:'), '\n')
+  console.log('')
+  console.log(COLOR.heading('IMS settings:'), '\n')
+
+  console.log(
+    COLOR.italic(
+      'IMS (Instructional Management Systems) Content Package is an interoperable standard format for packaging learning content between different LMSes.'
+    ),
+    '\n\nLearn more: https://www.imsglobal.org/content/packaging/index.html'
+  )
+  console.log('')
 
   COLOR.command(
     null,
     '--ims-indexeddb',
     '           Use IndexedDB to store data persistently'
   )
 
-  console.log('\n', COLOR.heading('WEB settings:'), '\n')
   console.log('')
+  console.log(COLOR.heading('WEB settings:'), '\n')
+
+  console.log(
+    COLOR.italic(
+      'Pack the project into a self contained web project that can be hosted everywhere.\n'
+    )
+  )
+
   COLOR.command(
     null,
     '--web-iframe',

src/export/ims.ts

@@ -5,7 +5,16 @@ const path = require('path')
 import puppeteer from 'puppeteer'
 
 export function help() {
-  console.log('\n', COLOR.heading('PDF settings:'), '\n')
+  console.log('')
+  console.log(COLOR.heading('PDF settings:'), '\n')
+
+  console.log(
+    COLOR.italic(
+      'PDF export generates printable documents from your LiaScript course using Puppeteer, a headless Chrome browser automation tool. This allows for high-quality rendering of all course elements including interactive content.'
+    )
+  )
+  console.log('\nLearn more: https://pptr.dev/')
+  console.log('')
 
   COLOR.command(
     null,
@@ -22,14 +31,19 @@ export function help() {
     '--pdf-timeout',
     '             Set an additional time horizon to wait until finished.'
   )
-  console.log(
-    '\nhttps://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagepdfoptions\n'
-  )
   COLOR.command(
     null,
     '--pdf-preview',
     '             Open preview-browser (default false), print not possible'
   )
+
+  console.log('')
+  console.log(COLOR.italic('The following are puppeteer specific settings.'))
+
+  console.log(
+    '\nLearn more: https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagepdfoptions\n'
+  )
+
   COLOR.command(
     null,
     '--pdf-scale',

src/export/pdf.ts

@@ -64,7 +64,24 @@ export function storeNext(collection: any, data: any) {
 }
 
 export function help() {
-  console.log('\n', COLOR.heading('Project settings:'), '\n')
+  console.log('')
+  console.log(COLOR.heading('Project settings:'), '\n')
+
+  console.log(
+    COLOR.italic(
+      'A project is a bundle for multiple LiaScript resource into a single project overview page, based on a provided yaml description.\n'
+    )
+  )
+
+  console.log(
+    'Learn more: https://www.npmjs.com/package/@liascript/exporter#project \n'
+  )
+  console.log('Example:')
+  console.log(
+    '- Input:  https://github.com/LiaBooks/liabooks.github.com/blob/main/project.yaml'
+  )
+  console.log('- Output: https://liabooks.github.io')
+  console.log('')
 
   COLOR.command(
     null,

src/export/project.ts

@@ -6,7 +6,20 @@ import fetch from 'node-fetch'
 import * as COLOR from '../colorize'
 
 export function help() {
-  console.log('\n', COLOR.heading('RDF settings:'), '\n')
+  console.log('')
+  console.log(COLOR.heading('RDF settings:'), '\n')
+
+  console.log(
+    COLOR.italic(
+      'RDF (Resource Description Framework) export generates structured metadata for your LiaScript course or your project-yaml in standard linked data formats. This helps with course discovery and enables semantic web applications to understand your content. Available output formats are n-quads and JSON-LD.'
+    )
+  )
+
+  console.log('\nLearn more:')
+  console.log('- RDF:     https://www.w3.org/RDF/')
+  console.log('- N-Quads: https://www.w3.org/TR/n-quads/')
+  console.log('- JSON-LD: https://json-ld.org/')
+  console.log('')
 
   COLOR.command(
     null,

src/export/rdf.ts

@@ -7,7 +7,17 @@ const path = require('path')
 const fs = require('fs-extra')
 
 export function help() {
-  console.log('\n', COLOR.heading('SCORM settings:'), '\n')
+  console.log('')
+  console.log(COLOR.heading('SCORM settings:'), '\n')
+
+  console.log(
+    COLOR.italic(
+      'SCORM (Sharable Content Object Reference Model) 1.2 & 2004 are standards for e-learning content that can be imported into LMS platforms like Moodle, Blackboard, and others.\n'
+    )
+  )
+
+  console.log('Learn more: https://scorm.com/scorm-explained/\n')
+
   COLOR.command(
     null,
     '--scorm-organization',

src/export/scorm12.ts

@@ -197,6 +197,14 @@ async function run(argument) {
 function help() {
   console.log(COLOR.heading('LiaScript-Exporter'))
   console.log('')
+  console.log(
+    COLOR.italic(
+      //2345678901234567890123456789012345678901234567890123456789012345678901234567890
+      'Export your LiaScript Markdown files to different formats. The following commandline options are available. Based on the selected output format, additional options can be used.'
+    )
+  )
+  console.log('')
+
   COLOR.command('-h', '--help', '           show this help')
 
   COLOR.command('-i', '--input', '          file to be used as input')