Using texmlbus

First time usage

Install and start the app as described above.

1. Goto http://localhost:8080
2. Click on Create Sample Set in the top menu.
3. Click on Create Samples button.
4. Click on Scan samples directory button to import some sample documents
5. Goto Documents alphabetically to see the documents.
6. Click on queue to convert a document.
7. Click on Destfile to see the converted document.

Importing documents

Files can be easily imported into the system. You can either upload files via the web interface or copy files directly to a subdirectory of the articles folder.

Uploading files

You can upload documents via Import/Manage → Upload files. After upload, click on "Import" do import the documents into the system. Either simple .tex files or zip files can be imported. Please see below how zip files should be structured.

Copying files

You can also create a subdirectory in texmlbus/volume/articles and copy documents there. Each article should be put in its own directory. After you have copied articles to the destination, please perform Import/Manage → Scan directory for documents to import the documents.

Zip file structure

You can either add simple .tex files or zip files.

The zip files may have the following structure:

    file.zip (extract to same directory)
        main.tex
        image.png

    file.zip (extract to sub-directory)
        subdir
            main.tex
            image.png

    file.zip (several documents in sub-directory)
        article1
            main.tex
            image.png
        article2
            main.tex
            image.png

Run edge configuration (texlive-2019 and texlive-2021)

It is possible to run different texlive (and different LaTeXML) versions at the same time. This helps you to compare differences between versions or detect compatibility problems. As it is not the default configuration, you have to explicitly add another LaTeXML branch manually. This branch is not part of the basic installation, therefore it is just added as a normal repository, not as a submodule.

1. cd texmlbus
2. docker-compose -f docker-compose.yml -f texmlbus-edge.yml up
3. # This will create a container with a second texlive distribution and a second LaTeXML installation.
   # Please be patient. Later the system will startup much faster.
   # The system will continue after displaying OK: 3xxx MiB in 1xx packages. Please be patient.
   # A stage named pdf_edge will automatically be activated.
   # Go to http://localhost:8080 or https://localhost:8443
4. # press Ctrl-C to stop the system.

If you would like to use edge and develop with latexml, you can also build the images yourself and update the images after changes.

1. cd texmlbus
2. git clone https://github.com/brucemiller/LaTeXML.git docker/LaTeXML_edge
4. docker-compose -f docker-compose.yml -f docker-compose-build.yml \\
   -f texmlbus-edge.yml -f texmlbus-edge-build.yml build
   # Please be patient.
5. docker-compose -f docker-compose.yml -f docker-compose-build.yml \\
   -f texmlbus-edge.yml -f texmlbus-edge-build.yml up
6. # Go to http://localhost:8080 or https://localhost:8443
7. # press Ctrl-C to stop the system.

Updating latexml

You can update latexml on your own.

1. cd docker/LaTeXML
2. git pull
3. cd ../..
4. docker-compose -f docker-compose.yml -f docker-compose-build.yml build

5. or ./build-images.sh (if using docker compose v2)