More website, especially referencing package.opendylan.org (#1595)

dylan-lang · May 19, 2024 · 80560a4 · 80560a4
2 parents f2c7af6 + ef7ec74
commit 80560a4
Show file tree

Hide file tree

Showing 29 changed files with 77 additions and 81 deletions.
diff --git a/documentation/README.rst b/documentation/README.rst
@@ -67,7 +67,7 @@ Link Validation
 Sphinx also makes it easy to check that all of the links to external sites
 are valid.  You can run the link checker by::
 
-    make linkcheck
+    make linkcheck | grep -v ' ok '
 
 Site Maintenance
 ================
@@ -79,10 +79,10 @@ Site Maintenance
    timer to update the documentation in various repositories by essentially
    doing a git pull and make html.
 
-   Note that the script copies package docs into
-   ``/var/www/opendylan.org/package/`` and copies the DRM to
-   ``/var/www/opendylan.org/books/drm/`` so it assumes there are no top-level
-   URLs starting with ``/books/drm`` or ``/package``.
+   Note that the script copies the DRM's ``.html`` files to
+   ``/var/www/opendylan.org/books/drm/`` directly.
+   ``/var/www/opendylan.org/downloads/`` **is maintained by hand** so keep a
+   backup of it somewhere.
 
 Section Header Markup
 =====================
@@ -106,5 +106,5 @@ Dylan Language Markup
 =====================
 
 There is a `Dylan language Sphinx domain
-<https://github.com/dylan-lang/sphinx-extensions/blob/master/sphinxcontrib/dylan/domain/reference.rst>`_
-to make it easier to document and refer to Dylan language entities.
+<https://package.opendylan.org/sphinx-extensions/>`_ to make it easier to
+document and refer to Dylan language entities.
diff --git a/documentation/source/about/examples/hello_world.rst b/documentation/source/about/examples/hello_world.rst
@@ -30,7 +30,7 @@ The canonical "Hello World" program in Dylan.
 
 
 .. hint:: The `deft new application
-          <https://opendylan.org/package/deft/index.html#deft-new-application>`_
+          <https://package.opendylan.org/deft/index.html#deft-new-application>`_
           command (called ``dylan new application`` in Open Dylan 2024.1 and
           older releases) will create these files for you, along with a test
           suite and build files.

diff --git a/documentation/source/building-with-duim/callbacks.rst b/documentation/source/building-with-duim/callbacks.rst
@@ -373,7 +373,7 @@ developing application, or in completely different applications.
    single: handling files in the task list manager
    single: task list manager; handling files
 
-.. _handling-files-in-the-task-list-manager:
+.. _callbacks--handling-files-in-the-task-list-manager:
 
 Handling files in the task list manager
 ---------------------------------------

diff --git a/documentation/source/building-with-duim/commands.rst b/documentation/source/building-with-duim/commands.rst
@@ -397,5 +397,5 @@ instance of ``<gadget>``. This change results in these new definitions:
 
 For details about ``note-task-selection-change``, see
 :ref:`enable-disable-buttons`. See
-:ref:`task-list-manager-using-command-tables` for the complete source code for
-the Task List 2 project.
+:ref:`source--task-list-manager-using-command-tables` for the complete source
+code for the Task List 2 project.
diff --git a/documentation/source/building-with-duim/design.rst b/documentation/source/building-with-duim/design.rst
@@ -67,7 +67,9 @@ button, list, and text controls.
    single: creating; basic sheet hierarchy
    single: sheet hierarchy; creating
    single: sheets; creating a sheet hierarchy
-
+
+.. _design--creating-the-basic-sheet-hierarchy:
+
 Creating the basic sheet hierarchy
 ----------------------------------
 

diff --git a/documentation/source/building-with-duim/improve.rst b/documentation/source/building-with-duim/improve.rst
@@ -2,8 +2,7 @@
 Improving The Design
 ********************
 
-The simple layout hierarchy described in `Creating the basic sheet
-hierarchy <design#creating-the-basic-sheet-hierarchy>`_ has a
+The simple layout hierarchy described in :ref:`design--creating-the-basic-sheet-hierarchy` has a
 number of problems associated with it, all of which revolve around the
 fact that the task list manager does not yet look very much like a
 standard Windows application. Although it is a simple design that does
@@ -255,9 +254,9 @@ radio box, and the list box from the initial design:
            activate-callback: not-yet-implemented);
 
 Note that the definition of each element is identical to the
-definitions included in the original layout described in `Creating the
-basic sheet hierarchy
-<design#creating-the-basic-sheet-hierarchy>`_ (except that
+definitions included in the original layout described in
+:ref:`design--creating-the-basic-sheet-hierarchy`
+(except that
 activate callbacks have been added to the code). Adding ``(frame)``
 immediately after the name of each pane lets you refer to the frame
 itself within the frame definition using a local variable. This means
@@ -269,8 +268,8 @@ the frame itself.
 
 In addition, you need to define the layout in which to place these
 panes. This is itself just another pane, and its definition is again
-identical to the original layout described in `Creating the basic
-sheet hierarchy <design#creating-the-basic-sheet-hierarchy>`_,
+identical to the original layout described in
+:ref:`design--creating-the-basic-sheet-hierarchy`,
 with one exception; rather than defining each element explicitly, you
 just include a reference to the relevant pane that you have already
 defined using normal slot syntax, thus:
@@ -616,8 +615,7 @@ has reduced to a single column layout whose children are ``task-list`` and
 
 The definition for the new design of the frame class now looks as
 follows (button definitions vary slightly for the Task List 2 project,
-see `A task list manager using command tables
-<source#a-task-list-manager-using-command-tables>`_):
+see :ref:`source--task-list-manager-using-command-tables`):
 
 .. code-block:: dylan
 

diff --git a/documentation/source/building-with-duim/menus.rst b/documentation/source/building-with-duim/menus.rst
@@ -283,7 +283,7 @@ stored, and a more complete description of these data structures is
 given in :ref:`defining-the-underlying-data-structures-for-tasks`. It
 transpires that defining the ``frame-task-list`` slot is essential for
 some of the file handling routines that are described in
-:ref:`handling-files-in-the-task-list-manager`.
+:ref:`callbacks--handling-files-in-the-task-list-manager`.
 
 .. code-block:: dylan
 

diff --git a/documentation/source/building-with-duim/source.rst b/documentation/source/building-with-duim/source.rst
@@ -11,7 +11,7 @@ task list manager. If you have followed the example given in :doc:`design`
 through :doc:`commands` from the beginning, then your code should be the
 same as the code given in :ref:`task-list-manager-using-menu-gadgets`. The
 source code for the second version of the task list manager, using command
-tables, is given in :ref:`task-list-manager-using-command-tables`.
+tables, is given in :ref:`source--task-list-manager-using-command-tables`.
 
 .. note: Please note that both projects have the same name within the source
    code— *task-list* —and you should not load them both into the environment
@@ -481,7 +481,7 @@ Contents of the file *task-list.dylan* :
    single: task list manager; command table implementation
    single: using; command tables
 
-.. _task-list-manager-using-command-tables:
+.. _source--task-list-manager-using-command-tables:
 
 A task list manager using command tables
 ----------------------------------------

diff --git a/documentation/source/building-with-duim/tour.rst b/documentation/source/building-with-duim/tour.rst
@@ -1849,9 +1849,8 @@ Note that DUIM provides default titles based on the specified direction,
 so you need only specify these titles if you want to supply a
 non-standard title to the dialog.
 
-Further examples of this function can be found in `Handling files in
-the task list manager
-<callbacks#handling-files-in-the-task-list-manager>`_.
+Further examples of this function can be found in
+:ref:`callbacks--handling-files-in-the-task-list-manager`.
 
 The convenience functions ``choose-color`` and ``choose-text-style``
 generate the common dialogs for choosing a color and a font

diff --git a/documentation/source/documentation/index.rst b/documentation/source/documentation/index.rst
@@ -14,7 +14,7 @@ Learn Dylan
     provides a gentler introduction to Dylan than does the :drm:`Dylan Reference
     Manual <Title>` (DRM).
 
-`Dylan Programming Guide <https://opendylan.org/package/dylan-programming-book/>`_
+`Dylan Programming Guide <https://package.opendylan.org/dylan-programming-book/>`_
     A book length Dylan tutorial.
 
 :doc:`../getting-started-cli/index`
@@ -58,7 +58,7 @@ Articles
     This essay explores Dylan from the perspective of a programmer used to
     traditional procedural languages, such as Pascal or C.
 
-`Dylan Package Documentation <https/package/http/server/quickstart/>`_
+`Dylan Package Documentation <https://package.opendylan.org/http/server/quickstart/>`_
     A quick introduction to web development in Dylan.
 
 :doc:`../news/2011/12/12/dswank` by Hannes Mehnert.

diff --git a/documentation/source/getting-started-cli/dylan-mode-for-emacs.rst b/documentation/source/getting-started-cli/dylan-mode-for-emacs.rst
@@ -36,7 +36,7 @@ Create the project with ::
 which creates a library named "dime-test" and a corresponding executable
 library and test suite, as well as downloading dependencies and creating
 registry files.  See the `deft new application
-<https://opendylan.org/package/deft/index.html#deft-new-application>`_
+<https://package.opendylan.org/deft/index.html#deft-new-application>`_
 command for more.
 
 **Start dime:**  ::

diff --git a/documentation/source/getting-started-cli/hello-world.rst b/documentation/source/getting-started-cli/hello-world.rst
@@ -47,7 +47,7 @@ executable library.
 
 5. :file:`dylan-package.json` describes the new "hello-world" package. This is
    where you can specify dependencies, the package location, etc. See the `deft
-   documentation <https://opendylan.org/package/deft/index.html>`_ for more on
+   documentation <https://package.opendylan.org/deft/index.html>`_ for more on
    this. Note that the existence of this file turns the "hello-world" directory
    into a :program:`deft` workspace.
 

diff --git a/documentation/source/getting-started-cli/managing-dependencies.rst b/documentation/source/getting-started-cli/managing-dependencies.rst
@@ -5,7 +5,7 @@ We recommend managing inter-library dependencies by use of the Dylan package
 manager and :program:`deft`. When using :program:`deft` dependencies are added
 to the "dylan-package.json" file in your project. Each dependency includes a
 `semantic version <https://semver.org>`_ and `dependency resolution
-<https://opendylan.org/package/deft/pacman.html#dependency-resolution>`_ is
+<https://package.opendylan.org/deft/pacman.html#dependency-resolution>`_ is
 done with "minimal version selection".  See the `deft`_ documentation for
 details.
 
@@ -81,4 +81,4 @@ a number of submodules, so you don't need to pull each
 of those in directly, but can reference them through
 the ``ext/http/`` directory.
 
-.. _deft: https://opendylan.org/package/deft/index.html
+.. _deft: https://package.opendylan.org/deft/index.html
diff --git a/documentation/source/getting-started-cli/platform-specific.rst b/documentation/source/getting-started-cli/platform-specific.rst
@@ -67,7 +67,7 @@ For further details of the LID file format, see :doc:`../library-reference/lid`.
 
    Platform-specific LID files should use the ``Platforms`` keyword to indicate
    which platforms they apply to. This tells the `deft update
-   <https://opendylan.org/package/deft/index.html#deft-update>`_ command which
+   <https://package.opendylan.org/deft/index.html#deft-update>`_ command which
    registry files to create.
 
    =============== ========================= =========================

diff --git a/documentation/source/getting-started-cli/source-registries.rst b/documentation/source/getting-started-cli/source-registries.rst
@@ -3,7 +3,7 @@ Using Source Registries
 
 .. note:: When using :program:`deft`, source registries are created for you via
           the `deft update
-          <https://opendylan.org/package/deft/index.html#deft-update>`_ command
+          <https://package.opendylan.org/deft/index.html#deft-update>`_ command
           and you should not have to create them explicitly. You may want to
           skip this section for now.
 
@@ -18,7 +18,7 @@ in the registry which is named the same as the library and contains a pointer
 to the ".lid" file for the library.  For example, here's the registry file for
 hello-world, created in the previous section. Note that this assumes you are
 still in the directory created by `deft new application
-<https://opendylan.org/package/deft/index.html#deft-new-application>`_.
+<https://package.opendylan.org/deft/index.html#deft-new-application>`_.
 
 ::
 
@@ -27,7 +27,7 @@ still in the directory created by `deft new application
 
 What's going on here?  First of all, the registry mechanism makes it possible
 to have platform-specific libraries.  `deft
-<https://opendylan.org/package/deft/index.html>`_ currently always writes
+<https://package.opendylan.org/deft/index.html>`_ currently always writes
 registry entries to a platform-specific directory, in this case
 ``x86_64-darwin``, but anything platform-independent can actually go in the
 :file:`registry/generic` subdirectory.

diff --git a/documentation/source/hacker-guide/topics/making-a-release.rst b/documentation/source/hacker-guide/topics/making-a-release.rst
@@ -116,7 +116,7 @@ now here is a manual check-list.
 #. On GitHub, move the release from Draft to Final.
 
 #. Publish the new release in pacman-catalog with `deft publish
-   <https://opendylan.org/package/deft/index.html#deft-publish>`_.
+   <https://package.opendylan.org/deft/index.html#deft-publish>`_.
 
 #. Announce the release. Check previous announcements for ideas, but no need to
    slavishly copy the format.

diff --git a/documentation/source/index.rst b/documentation/source/index.rst
@@ -71,7 +71,7 @@ articles, and all the library docs.
 
 *Happy hacking!*
 
-.. _Dylan Programming Guide: https://opendylan.org/books/dpg/
+.. _Dylan Programming Guide: https://package.opendylan.org/dylan-programming-book/
 .. _Dylan Reference Manual: https://opendylan.org/books/drm/
 .. _Dylan: books/drm/Title
 .. _Matrix: https://app.element.io/#/room/#dylan-language:matrix.org
@@ -92,15 +92,15 @@ articles, and all the library docs.
 
    Tour of Dylan <about/index>
    Getting Started Guide <getting-started-cli/index>
-   Dylan Programming Guide <https://opendylan.org/books/dpg/>
+   Dylan Programming Guide <https://package.opendylan.org/dylan-programming-book/>
    Dylan Playground <https://play.opendylan.org>
 
 .. toctree::
    :caption: Reference
    :hidden:
 
    Dylan Reference Manual <https://opendylan.org/books/drm/>
-   Package Docs <https://opendylan.org/package/>
+   Package Docs <https://package.opendylan.org/>
    Open Dylan Libraries <library-reference/index>
    All Documentation <documentation/index>
    Full Index <genindex>
diff --git a/documentation/source/library-reference/index.rst b/documentation/source/library-reference/index.rst
@@ -5,7 +5,7 @@ This reference describes the libraries provided with Open Dylan, either as part
 of the "opendylan" repository or included therein as submodules. It also
 documents Dylan language extensions and the LID file format.
 
-See the `Dylan Package Docs <https://opendylan.org/package/>`_ for documentation
+See the `Dylan Package Docs <https://package.opendylan.org/>`_ for documentation
 on published Dylan packages.
 
 Contents:

diff --git a/documentation/source/news/2012/10/15/command-line-parser.rst b/documentation/source/news/2012/10/15/command-line-parser.rst
@@ -12,7 +12,7 @@ completely rewritten to
   * be far less verbose
   * have simplified usage
   * have automatic support for --help
-  * be `documented <https://opendylan.org/package/command-line-parser/>`_
+  * be `documented <https://package.opendylan.org/command-line-parser/>`_
 
 Testworks and the HTTP server are using the new library.  More
 enhancements coming soon.
diff --git a/documentation/source/news/2013/01/21/dylan-programming-guide.rst b/documentation/source/news/2013/01/21/dylan-programming-guide.rst
@@ -6,9 +6,9 @@ Dylan Programming Guide
 =======================
 
 The `Dylan Programming Guide`_ has been updated to
-use our new documentation format.  As a result it is
-now available in `PDF`_ and `ePub`_ formats as well
-as much improved HTML.
+use our new documentation format.  As a result the
+HTML is much improved. and it can easily be built in
+epub and PDF formats as well.
 
 The Dylan Programming Guide is a great introduction
 to programming in Dylan and was written by Neil
@@ -33,7 +33,5 @@ We hope that this will be helpful in introducing a
 new generation of programmers to the Dylan programming
 language.
 
-.. _Dylan Programming Guide: https://opendylan.org/books/dpg/
-.. _PDF: https://opendylan.org/books/dpg/DylanProgramming.pdf
-.. _ePub: https://opendylan.org/books/dpg/DylanProgramming.epub
+.. _Dylan Programming Guide: https://package.opendylan.org/dylan-programming-book/
 .. _Pygments: https://pygments.org/
diff --git a/documentation/source/news/2013/06/30/dylan-hack-a-thon.rst b/documentation/source/news/2013/06/30/dylan-hack-a-thon.rst
@@ -26,6 +26,6 @@ Europe, South East Asia and perhaps New Zealand.
 We look forward to seeing you there!
 
 
-.. _learn Dylan: https://opendylan.org/books/dpg/
+.. _learn Dylan: https://package.opendylan.org/dylan-programming-book/
 .. _list of tasks: https://github.com/dylan-lang/opendylan/wiki
 .. _contact us on IRC or via email: https://opendylan.org/community/index.html
diff --git a/documentation/source/news/index.rst b/documentation/source/news/index.rst
@@ -13,8 +13,9 @@ Release 2023.1
 * Updated versions of LLVM and the BDW garbage collector.
 * New ``"""multi-line"""`` and ``#r"raw"`` string literals (`DEP 12
   <../proposals/dep-0012-string-literals.rst>`_).
-* The `dylan <https://opendylan.org/package/dylan-tool/>`_ tool continues to
-  evolve with a new, simplified workspace model.
+* The ``dylan`` tool (renamed to `deft <https://package.opendylan.org/deft/>`_
+  in Open Dylan 2024.2) continues to evolve with a new, simplified workspace
+  model.
 * Bug fixes for json, command-line-parser, system, and others.
 
 See the `release notes <../release-notes/2023.1.rst>`_ for more details.
@@ -38,7 +39,7 @@ overhaul. The goals of this revamp were:
 #. Local table of contents in the right sidebar. Hooray `Furo
    <https://pradyunsg.me/furo/quickstart/>`_!
 
-#. Integrated `package docs <https://opendylan.org/package/>`_.
+#. Integrated `package docs <https://package.opendylan.org/>`_.
 
 #. Simplicity! We're a small team so we want to avoid any extra maintenance
    burden. To that end, we no longer use a Dylan-specific Sphinx theme or
@@ -123,9 +124,10 @@ Hack-a-thon
 </news/2013/06/30/dylan-hack-a-thon>`
 
 No matter if you know Dylan or not, we can help you `learn Dylan
-<https://opendylan.org/books/dpg/>`_ or put your other skills to use. We've got
-a good `list of tasks <https://github.com/dylan-lang/opendylan/wiki>`_ that
-we're collecting and some people will bring their own Dylan-related projects.
+<https://package.opendylan.org/dylan-programming-book/>`_ or put your other
+skills to use. We've got a good `list of tasks
+<https://github.com/dylan-lang/opendylan/wiki>`_ that we're collecting and some
+people will bring their own Dylan-related projects.
 
 
 Updated Dylan Programming Guide

diff --git a/documentation/source/release-notes/2013.2.rst b/documentation/source/release-notes/2013.2.rst
@@ -18,9 +18,9 @@ Improvements
 Documentation
 -------------
 
-The `logging <https://opendylan.org/library-reference/logging/>`_ library has been documented.
+The `logging <https://package.opendylan.org//logging/>`_ library has been documented.
 
-The `regular-expressions <https://opendylan.org/library-reference/regular-expressions/index.html>`_ library documentation has been greatly improved.
+The `regular-expressions <https://package.opendylan.org//regular-expressions/>`_ library documentation has been greatly improved.
 
 The `date <https://opendylan.org/library-reference/system/date.html>`_ module documentation has been improved and now covers date formatting and parsing.
 
@@ -94,7 +94,7 @@ hash-algorithms
 ^^^^^^^^^^^^^^^
 
 A hash algorithms library has been added that supports the MD5, SHA-1, SHA256,
-SHA384, and SHA512 algorithms. `Documentation <https://opendylan.org/package/hash-algorithms/>`_
+SHA384, and SHA512 algorithms. `Documentation <https://package.opendylan.org/hash-algorithms/>`_
 is available. This library was written by Hannes Mehnert.
 
 I/O

diff --git a/documentation/source/release-notes/2014.1.rst b/documentation/source/release-notes/2014.1.rst
@@ -283,4 +283,4 @@ Testworks
   forward reference".
 
 * Benchmarks are once again supported.  See the `documentation
-  <https://opendylan.org/package/testworks/>`_ for details.
+  <https://package.opendylan.org/testworks/>`_ for details.
diff --git a/documentation/source/release-notes/2020.1.rst b/documentation/source/release-notes/2020.1.rst
@@ -327,7 +327,7 @@ testworks Library
 
 * The testworks-specs library has been folded into testworks and has been
   greatly simplified. See `Interface Specification Suites
-  <https://opendylan.org/package/testworks/usage.html#interface-specification-suites>`_. Note
+  <https://package.opendylan.org/testworks/usage.html#interface-specification-suites>`_. Note
   that the new specification suites no longer expect you to define one test per
   exported name in your interface module. Instead you can write tests in
   whatever way best suits your needs and the interface specification suite only