Wrong/Missing docs for custom index.html

jaminfine commented 5 years ago

After compiling my app, I saw this in the default index.html:

  <!-- This index.html can be customised by creating a boot/index.html (do not include Qooxdoo application script tags like
       the one below because they will be added automatically)
    -->

This is not accurate. The default path for the custom index.html seems to be "" (empty string.) The bootPath must be specified in compile.json for the custom index.html to be used:

"applications": [
    {
      "class": "guestnic.Application",
      "theme": "guestnic.theme.Theme",
      "name": "script",
      "bootPath": "./boot"
    }

I am unsure of if this is intended, or if the default bootPath should be "./boot"

This information should be added to the wiki page about compile.json: https://github.com/qooxdoo/qooxdoo-compiler/wiki/compile.json EDIT: Thank you for linking me to the correct documentation for compile.json. Perhaps this wiki page should be removed?

When compiled with this bootPath specified, I get the following warnings on compilation:

Warning: There is no reference to ${preBootJs} in the index.html copied from /home/bfine/Mutualink/amb.git/guestnic/boot/index.html (see https://git.io/fh7NI)
Warning: There is no reference to boot.js script in the index.html copied from /home/bfine/Mutualink/amb.git/guestnic/boot/index.html (see https://git.io/fh7NI)

The link given, https://git.io/fh7NI is broken.

hkollmann commented 5 years ago

The current documentation for compile.json is found here: http://www.qooxdoo.org/docs/#/configuration/compile.

The wiki is old and not maintenanted

TechplexEngineer commented 5 years ago

@hkollmann I just had the same issue @jaminfine. The compiler output an error message with the git.io link that is broken. It seems https://git.io/fh7NI expands to https://github.com/qooxdoo/qooxdoo-compiler/blob/master/docs/compiler/CustomAppStartup.md#custom-indexhtml-for-your-applications

It seems the link could point here: https://github.com/qooxdoo/qooxdoo/blob/master/docs/compiler/CustomAppStartup.md

Not sure how to find that page from the web docs http://www.qooxdoo.org/docs/#/cli/commands

npx qx --version
1.0.0-beta.20190731-0654

qooxdoo / qooxdoo-compiler

Wrong/Missing docs for custom index.html #530