Fossil SCM
Updates to the "How The Download Page Works" document.
Commit
498cfbf76aa6270d3a7d39ef51c9be9253d54c0c5996f01b6e6aa6edf2bb96e2
Parent
ff747b5151fa2ed…
1 file changed
+20
-14
+20
-14
| --- www/aboutdownload.wiki | ||
| +++ www/aboutdownload.wiki | ||
| @@ -6,18 +6,19 @@ | ||
| 6 | 6 | The [/uv/download.html|Download] page for the Fossil self-hosting |
| 7 | 7 | repository is implemented using [./unvers.wiki|unversioned files]. |
| 8 | 8 | The "download.html" screen itself, and the various build products |
| 9 | 9 | are all stored as unversioned content. The download.html page |
| 10 | 10 | uses AJAX to retrieve the [/help?cmd=/juvlist|/juvlist] webpage |
| 11 | -for a list of all unversioned files. Javascript within the | |
| 12 | -download.html page then figures out which unversioned files are | |
| 11 | +for a list of all unversioned files. Javascript in the | |
| 12 | +[/uv/download.js?mimetype=text/plain|download.js] file (which is | |
| 13 | +sourced by "download.html") then figures out which unversioned files are | |
| 13 | 14 | build products and paints appropriate icons on the displayed |
| 14 | 15 | download page. |
| 15 | 16 | |
| 16 | 17 | When a new version is generated, the developers use the |
| 17 | 18 | [/help?cmd=uv|fossil uv edit] command to make minor changes |
| 18 | -to the "[/uv/download.html?mimetype=text/plain|download.html]" | |
| 19 | +to the "[/uv/download.js?mimetype=text/plain|download.js]" | |
| 19 | 20 | file so that it knows about the |
| 20 | 21 | new version number. Then the developers run |
| 21 | 22 | the [/help?cmd=uv|fossil uv add] command for each |
| 22 | 23 | build product. Finally, the |
| 23 | 24 | [/help?cmd=uv|fossil uv sync] command is run to push all |
| @@ -25,31 +26,36 @@ | ||
| 25 | 26 | [./selfhost.wiki|three self-hosting repositories] for Fossil |
| 26 | 27 | are updated automatically. |
| 27 | 28 | |
| 28 | 29 | <h2>2.0 Details</h2> |
| 29 | 30 | |
| 30 | -The current text of the "download.html" file can be seen | |
| 31 | -[/uv/download.html?mimetype=text/plain|here]. (Mouse-over that | |
| 32 | -hyperlink to see how the "mimetype=text/plain" query parameter | |
| 33 | -is added in order to display the file as plain text instead of | |
| 34 | -the usual HTML.) The default mimetype for "download.html" is | |
| 35 | -text/html. But because the entire page is enclosed within | |
| 31 | +The current text of the "download.html" and "download.js" files can | |
| 32 | +be seen at: | |
| 33 | + | |
| 34 | + * [/uv/download.html?mimetype=text/plain] | |
| 35 | + * [/uv/download.js?mimetype=text/plain] | |
| 36 | + | |
| 37 | +Notice how the hyperlinks above use the "mimetype=text/plain" | |
| 38 | +query parameter in order to display the file as plain text | |
| 39 | +instead of the usual HTML or Javascript. | |
| 36 | 40 | |
| 41 | +The default mimetype for "download.html" is | |
| 42 | +text/html. But because the entire page is enclosed within | |
| 37 | 43 | |
| 38 | 44 | <b><div class='fossil-doc' data-title='Download Page'>...</div></b> |
| 39 | 45 | |
| 40 | 46 | Fossil knows to add its standard header and footer information to the |
| 41 | 47 | document, making it look just like any other page. See |
| 42 | 48 | "[./embeddeddoc.wiki|embedded documentation]" for further details on |
| 43 | -how this works. | |
| 49 | +how <div class='fossil-doc'> this works. | |
| 44 | 50 | |
| 45 | 51 | With each new release, the "releases" variable in the javascript on |
| 46 | -the [/uv/download.html?mimetype=text/plain|download.html] page is | |
| 47 | -edited (using "[/help?cmd=uv|fossil uv edit download.html]") to add | |
| 52 | +the [/uv/download.js?mimetype=text/plain|download.js] page is | |
| 53 | +edited (using "[/help?cmd=uv|fossil uv edit download.js]") to add | |
| 48 | 54 | details of the release. |
| 49 | 55 | |
| 50 | -When the javascript on the "download.html" page runs, it requests | |
| 56 | +When the javascript in the "download.js" file runs, it requests | |
| 51 | 57 | a listing of all unversioned content using the /juvlist URL. |
| 52 | 58 | ([/juvlist|sample /juvlist output]). The content of the download page is |
| 53 | 59 | constructed by matching unversioned files against regular expressions |
| 54 | 60 | in the "releases" variable. |
| 55 | 61 | |
| @@ -62,11 +68,11 @@ | ||
| 62 | 68 | [/help?cmd=uv|fossil uv sync] to push the new build product to the |
| 63 | 69 | [./selfhost.wiki|various servers]. This process is repeated for |
| 64 | 70 | each build product. |
| 65 | 71 | |
| 66 | 72 | When older builds are retired from the download page, the |
| 67 | -[/uv/download.html?mimetype=text/plain|download.html] page is again | |
| 73 | +[/uv/download.js?mimetype=text/plain|download.js] page is again | |
| 68 | 74 | edited to remove the corresponding entry from the "release" variable |
| 69 | 75 | and the edit is synced using |
| 70 | 76 | [/help?cmd=uv|fossil uv sync]. This causes the build products to |
| 71 | 77 | disappear from the download page immediately. But those build products |
| 72 | 78 | are still taking up space in the unversioned content table of the |
| 73 | 79 |
| --- www/aboutdownload.wiki | |
| +++ www/aboutdownload.wiki | |
| @@ -6,18 +6,19 @@ | |
| 6 | The [/uv/download.html|Download] page for the Fossil self-hosting |
| 7 | repository is implemented using [./unvers.wiki|unversioned files]. |
| 8 | The "download.html" screen itself, and the various build products |
| 9 | are all stored as unversioned content. The download.html page |
| 10 | uses AJAX to retrieve the [/help?cmd=/juvlist|/juvlist] webpage |
| 11 | for a list of all unversioned files. Javascript within the |
| 12 | download.html page then figures out which unversioned files are |
| 13 | build products and paints appropriate icons on the displayed |
| 14 | download page. |
| 15 | |
| 16 | When a new version is generated, the developers use the |
| 17 | [/help?cmd=uv|fossil uv edit] command to make minor changes |
| 18 | to the "[/uv/download.html?mimetype=text/plain|download.html]" |
| 19 | file so that it knows about the |
| 20 | new version number. Then the developers run |
| 21 | the [/help?cmd=uv|fossil uv add] command for each |
| 22 | build product. Finally, the |
| 23 | [/help?cmd=uv|fossil uv sync] command is run to push all |
| @@ -25,31 +26,36 @@ | |
| 25 | [./selfhost.wiki|three self-hosting repositories] for Fossil |
| 26 | are updated automatically. |
| 27 | |
| 28 | <h2>2.0 Details</h2> |
| 29 | |
| 30 | The current text of the "download.html" file can be seen |
| 31 | [/uv/download.html?mimetype=text/plain|here]. (Mouse-over that |
| 32 | hyperlink to see how the "mimetype=text/plain" query parameter |
| 33 | is added in order to display the file as plain text instead of |
| 34 | the usual HTML.) The default mimetype for "download.html" is |
| 35 | text/html. But because the entire page is enclosed within |
| 36 | |
| 37 | |
| 38 | <b><div class='fossil-doc' data-title='Download Page'>...</div></b> |
| 39 | |
| 40 | Fossil knows to add its standard header and footer information to the |
| 41 | document, making it look just like any other page. See |
| 42 | "[./embeddeddoc.wiki|embedded documentation]" for further details on |
| 43 | how this works. |
| 44 | |
| 45 | With each new release, the "releases" variable in the javascript on |
| 46 | the [/uv/download.html?mimetype=text/plain|download.html] page is |
| 47 | edited (using "[/help?cmd=uv|fossil uv edit download.html]") to add |
| 48 | details of the release. |
| 49 | |
| 50 | When the javascript on the "download.html" page runs, it requests |
| 51 | a listing of all unversioned content using the /juvlist URL. |
| 52 | ([/juvlist|sample /juvlist output]). The content of the download page is |
| 53 | constructed by matching unversioned files against regular expressions |
| 54 | in the "releases" variable. |
| 55 | |
| @@ -62,11 +68,11 @@ | |
| 62 | [/help?cmd=uv|fossil uv sync] to push the new build product to the |
| 63 | [./selfhost.wiki|various servers]. This process is repeated for |
| 64 | each build product. |
| 65 | |
| 66 | When older builds are retired from the download page, the |
| 67 | [/uv/download.html?mimetype=text/plain|download.html] page is again |
| 68 | edited to remove the corresponding entry from the "release" variable |
| 69 | and the edit is synced using |
| 70 | [/help?cmd=uv|fossil uv sync]. This causes the build products to |
| 71 | disappear from the download page immediately. But those build products |
| 72 | are still taking up space in the unversioned content table of the |
| 73 |
| --- www/aboutdownload.wiki | |
| +++ www/aboutdownload.wiki | |
| @@ -6,18 +6,19 @@ | |
| 6 | The [/uv/download.html|Download] page for the Fossil self-hosting |
| 7 | repository is implemented using [./unvers.wiki|unversioned files]. |
| 8 | The "download.html" screen itself, and the various build products |
| 9 | are all stored as unversioned content. The download.html page |
| 10 | uses AJAX to retrieve the [/help?cmd=/juvlist|/juvlist] webpage |
| 11 | for a list of all unversioned files. Javascript in the |
| 12 | [/uv/download.js?mimetype=text/plain|download.js] file (which is |
| 13 | sourced by "download.html") then figures out which unversioned files are |
| 14 | build products and paints appropriate icons on the displayed |
| 15 | download page. |
| 16 | |
| 17 | When a new version is generated, the developers use the |
| 18 | [/help?cmd=uv|fossil uv edit] command to make minor changes |
| 19 | to the "[/uv/download.js?mimetype=text/plain|download.js]" |
| 20 | file so that it knows about the |
| 21 | new version number. Then the developers run |
| 22 | the [/help?cmd=uv|fossil uv add] command for each |
| 23 | build product. Finally, the |
| 24 | [/help?cmd=uv|fossil uv sync] command is run to push all |
| @@ -25,31 +26,36 @@ | |
| 26 | [./selfhost.wiki|three self-hosting repositories] for Fossil |
| 27 | are updated automatically. |
| 28 | |
| 29 | <h2>2.0 Details</h2> |
| 30 | |
| 31 | The current text of the "download.html" and "download.js" files can |
| 32 | be seen at: |
| 33 | |
| 34 | * [/uv/download.html?mimetype=text/plain] |
| 35 | * [/uv/download.js?mimetype=text/plain] |
| 36 | |
| 37 | Notice how the hyperlinks above use the "mimetype=text/plain" |
| 38 | query parameter in order to display the file as plain text |
| 39 | instead of the usual HTML or Javascript. |
| 40 | |
| 41 | The default mimetype for "download.html" is |
| 42 | text/html. But because the entire page is enclosed within |
| 43 | |
| 44 | <b><div class='fossil-doc' data-title='Download Page'>...</div></b> |
| 45 | |
| 46 | Fossil knows to add its standard header and footer information to the |
| 47 | document, making it look just like any other page. See |
| 48 | "[./embeddeddoc.wiki|embedded documentation]" for further details on |
| 49 | how <div class='fossil-doc'> this works. |
| 50 | |
| 51 | With each new release, the "releases" variable in the javascript on |
| 52 | the [/uv/download.js?mimetype=text/plain|download.js] page is |
| 53 | edited (using "[/help?cmd=uv|fossil uv edit download.js]") to add |
| 54 | details of the release. |
| 55 | |
| 56 | When the javascript in the "download.js" file runs, it requests |
| 57 | a listing of all unversioned content using the /juvlist URL. |
| 58 | ([/juvlist|sample /juvlist output]). The content of the download page is |
| 59 | constructed by matching unversioned files against regular expressions |
| 60 | in the "releases" variable. |
| 61 | |
| @@ -62,11 +68,11 @@ | |
| 68 | [/help?cmd=uv|fossil uv sync] to push the new build product to the |
| 69 | [./selfhost.wiki|various servers]. This process is repeated for |
| 70 | each build product. |
| 71 | |
| 72 | When older builds are retired from the download page, the |
| 73 | [/uv/download.js?mimetype=text/plain|download.js] page is again |
| 74 | edited to remove the corresponding entry from the "release" variable |
| 75 | and the edit is synced using |
| 76 | [/help?cmd=uv|fossil uv sync]. This causes the build products to |
| 77 | disappear from the download page immediately. But those build products |
| 78 | are still taking up space in the unversioned content table of the |
| 79 |