ADA Manual

Rapid multi-format publishing

by ADA Community

v1.0

Published by: ADA-Pileline

Last Updated: 2022-04-07

Created: 2022-04-07

Language: English

Created by: Simon Worthington

About

If you would liek to contribute to the ADA-Pipeline manual that covers using Fidus Writer, Git, Vivliostyle, and distribution then please drop into the discussion area.

Sharing Docs and Books with Your Contacts

You can invite your collaborators to have access to documents and books. This can be done in a variety of locations across the platform:

Note: Only the single document or book owner can manage access to files.

Inviting contact to the platform

Users will be sent an invite email to join the platform.

Your contact must accept this invite and agree to the site terms and condition so as to comply with our privacy policy. Contacts cannot be added without having given consent.

If the user is already a platform member they will receive a message saying they have been ivited to have access to the files.

You can view your contact in your account area and per file.

Note: If a contact joins the platform with their GitLab or GitHub account your invite to the files you are shaing will only work if that account uses the same email address from your invite.

Types of contact access

Contact can be given different levels of access: viewer, reviewer, editor. Ensure you give editing rights for fellow authors.

Sharing from the file manager

The following works the same for documents or books. You need to be in the corrsponding Documents or Books area.

View your document in the Documents file list and select the documents you want to share with your contacts.

From the menu above the document selection top left select share.

Then select contacts to add to share your document with.

When you add a contacts you can set the access levels. For authors set there access level to write.

If the contact is not in your contacts list you can add them by adding their email address or user name.

Outputting to GitHub and GitLab

You can output your publication to GitHub and GitLab.

Before outputting you should use the ADA-Pipeline template supplied on GitHub and you will have to make a few configurations. These will be documented shortly (April 22).

GitHub

  1. Authorise access to your GitHub account in the profile area.

  2. Navigate to your book.

  3. In the book information area go to the Git tab and choose the repository name you want to export to.

  4. Bottom right select Save to Git to output, you will need to add a commit message which will appear on GitHub.

  5. Choose the file types you want to output, UHTML is required, the other formats are optional.

  6. A status message will apprear bottom right. When its says 'Successfully outputted to Git' then your book files are on GitHub.

  7. Navigate to GitHub and your book will be live. You will ahev to wait about a minute for GitHub to refresh the GitHub Pages site.

  8. Outputting is complete.

  9. You can repeat the outputting as often as you like.

Glossary