Rst2HTML restuctured text source

Loading

Below the buttons for loading and saving the site settings is a row of buttons for working with the ReST sources. Starting with the button to load a text next to the document selector:

/docs/rst2html/source/load-source.png

This button can perform various functions depending on the choice you make in de selector next to it:

/docs/rst2html/source/load-source-options.png

First simply loading a source text into the content area of course, but it's also possible to check a document's status (or progress in the system). This is short enough to be shown in the message field:

/docs/rst2html/source/load-status.png

It's also possible to view the latest changes in a document. This is shown in a so-called "diff view" (old text preceded by a minus sign, new text preceded with a plus sign, with some unchanged text around it for context) loaded into the content area:

/docs/rst2html/source/load-changes.png

On loading the source text, the target selector is also updated; this has the added effect that you can see if the text had been converted to HTML earlier because it remains empty if it wasn't.

To keep documents on the site similar in structure you can use the template functionality.

Saving

Next to the load selector we have the button for saving:

/docs/rst2html/source/save-source.png

This one also comes with a selector to specify what you want it to do:

/docs/rst2html/source/save-source-options.png

You can perform the following actions:

  • just save: save the text in the content area under the name chosen in the source selector; if the "new name" field contains a value then that is used instead - this makes it possible to save a document under a different name. See <working with templates <../template/>`_ for a description of what you can use this for.

  • rename: change the name of the saved document. Also use the new name field for this.

  • revert: change the text back to the previous version. It's rather limited as you can do this only once and after that you can't view changes anymore.

  • delete: remove the saved document. If it hads been converted to HTML and/or copied to the mirror site you have to migrate the deletion also, you can use the "pending deletions" as described in the target document for this.

You can use the save function to subdivide the site you're working on by using a name ending with a slash (/), this is similar to creating a subdirectory.

/docs/rst2html/source/new-directory.png

After creating the subdivision, you can select

/docs/rst2html/source/selecting-directory.png

and "load" it, making sure that subsequent documents are created in this section of the site.

/docs/rst2html/source/switching-to-subdir.png

You can go back to the main section by selecting the ".." entry in the source selector.

/docs/rst2html/source/selecting-parent.png /docs/rst2html/source/switching-to-parent.png

Viewing and migrating

The next function makes it possible to view the ReST source as it would be converted to HTML:

/docs/rst2html/source/source-preview.png

On the screen showing the converted text a button is created with which you can close the preview and return to the document. Before you could only do that with the browser's "back button" (you still can, of course) but then you may lose your latest changes, which is why I added the button (under the hood the page is saved before converting and reloaded upon closing the preview).

/docs/rst2html/source/view-source.png

Finally there is the button to commit the conversion to the database, i.e. copy the generated HTML to the target environment.

/docs/rst2html/source/source-to-target.png

Notification of results

When you load a source document a message will be shown with the path of the document relative to the server root (the same one appears after closing the preview). A similar message appears on saving. Other acivities also generate a message, this way you can always see what you just did (and if it succeeded).