Support

Admin Tools

#38228 Would You Please Provide Your Documentation for both Akeeba Admin Tools AND Akeeba Backup in PDF Format?

Posted in ‘Admin Tools for Joomla! 4 & 5’
This is a public ticket

Everybody will be able to see its contents. Do not include usernames, passwords or any other sensitive information.

Environment Information

Joomla! version
n/a
PHP version
n/a
Admin Tools version
n/a

Latest post by nicholas on Monday, 26 December 2022 11:32 CST

c92r4i5dW8s4FvtM9TQsfns

Hello,

 

In the past, you have always provided documentation for Akeeba Admin Tools pro and Akeeba Backup in PDF format.  Today, I just renewed my license and noticed that they are only available either online or using epub format.

 

It is much easier for me to read long documentation offline, as a PDF.  I understand that I can install an extension from a third-party into my browser, or download third-party readers to view the ePub file.  However, I don't want to download any additional software.

 

Would you please add the PDF versions of your documentation for both Admin Tools Pro and Akeeba Backup Pro?

 

Thank you

nicholas
Akeeba Staff
Manager

You do not have to download additional software to read the ePub file. Rename it to .zip and extract it. There are XHTML files under the OEBPS folder. You can open them in your browser. You can also use the ePub file with any e-book reader application you might be using, be it Apple Books, Amazon Kindle, or anything else. 

Beyond that, the decision to move from PDF to ePub wasn't random. Converting from the source DocBook XML 5 format of the documentation to PDF required converting it first to XSL-FO and then using Apache FOP to convert the XSL-FO intermediate file to PDF. XSL-FO was deprecated in 2013. W3G recommends that HTML with CSS3 is used instead (see https://en.wikipedia.org/wiki/XSL_Formatting_Objects#Replacement). The conversion process was also extremely slow (5 minutes for Akeeba Backup's documentation, for example) which made releases painful — especially since bugs in Apache FOP would stop the release process cold with an error that an image can't fit the page by one thousandth of a millimetre. PDF is designed as a print format file. Using it on a screen —such on a desktop, tablet, or smartphone— is problematic as it requires a lot of zooming in and out. This has been a problem reported multiple times by many users.

ePub solves all these problems. ePub is just HTML, CSS, and metadata; converting the DocBook XML source to chunked HTML is fully supported by the tooling. The conversion process is two orders of magnitude faster, and it doesn't break the release process. The content can be reflowed to any viewport dimension, making reading the documentation even on a smartphone not just possible, but actually practical.

In short, PDF was all shorts of problematic. We are not going to be producing PDF files anymore.

Nicholas K. Dionysopoulos

Lead Developer and Director

🇬🇷Greek: native 🇬🇧English: excellent 🇫🇷French: basic • 🕐 My time zone is Europe / Athens
Please keep in mind my timezone and cultural differences when reading my replies. Thank you!

c92r4i5dW8s4FvtM9TQsfns

Thank you for the detailed reply.  I was able to convert the .ePub files to .zip files, as you described, and to access the documentation.  Problem solved :)  Thanks again!

nicholas
Akeeba Staff
Manager

You're welcome!

Nicholas K. Dionysopoulos

Lead Developer and Director

🇬🇷Greek: native 🇬🇧English: excellent 🇫🇷French: basic • 🕐 My time zone is Europe / Athens
Please keep in mind my timezone and cultural differences when reading my replies. Thank you!

Support Information

Working hours: We are open Monday to Friday, 9am to 7pm Cyprus timezone (EET / EEST). Support is provided by the same developers writing the software, all of which live in Europe. You can still file tickets outside of our working hours, but we cannot respond to them until we're back at the office.

Support policy: We would like to kindly inform you that when using our support you have already agreed to the Support Policy which is part of our Terms of Service. Thank you for your understanding and for helping us help you!