Skip to main content
How to Create A Custom HPUB

Is it possible to convert ZIP package into HPUB? How do I need to do to upload my custom HPUB?

Okka avatar
Written by Okka
Updated over 3 years ago

It is possible for you to create a custom HPUB and upload it to the MagLoft portal. Please see the steps below to guide you to do so.

1. Prepare your ZIP package.

2. Unzip the issue file.

3. Create a book.json file. Please see the format below.

{
"hpub": 1,
"title": "2020 Issue 2 H5",
"author": [
"anonymous"
],
"date": "2020-07-08",
"url": "book://2020issue2h5",
"orientation": "portrait",
"zoomable": true,
"-baker-background": "#ededed",
"-baker-vertical-bounce": true,
"-baker-media-autoplay": true,
"-baker-page-numbers-color": "#000000",
"-baker-rendering": "three-cards",
"cover": "cover.jpg",
"navigator": "disable",
"contents": [
"index.html"
]
}

Mandatory property :

- hpub : Int

Number identify for Book.json (default 1)

- title : String

Issue title

- author : Array String

Name of the issue author

- creator : Array String

Name of the issue creator

- date : String

Issue date created

- url : String

Issue URL that is used for sharing

- orientation : String (both, portrait, landscape)

The specific orientation setting

- -baker-background : String (hex color : #FFFFFF)

Issue Reader background-colour

- -baker-index-height : Int

Height of IndexView (Navigator) file inside Issue Reader

- -baker-media-autoplay : Bool

The setting for media autoplay when Issue Page loaded

- -baker-vertical-bounce : Bool

The setting for vertical bounce scroll view in the Issue Page

- -baker-page-turn-tap : Bool

The setting for enable page change with a tap inside left/right area in the Issue page

- -baker-start-at-page : Int

Initial load page of Issue when start reading

- -baker-dual-spread : Bool

Enable/disable dual spread (only for pdf Issue)

- notch-padding : Bool

Enable/disable notch area padding in the Issue Reader

- source : String (typeloft, pdf, hpub, epub)

Issue type

- contents : Array String

List of pages that available inside the Issue

Optional (if we want to use specific configuration) :

- orientation_phone : String (both, portrait, landscape)

Specific orientation (for Issue/all pages) for the phone device

- orientation_tablet : String (both, portrait, landscape)

Specific orientation (for Issue/all pages) for the tablet device

- navigator : String (disable, FILE_NAME)

Specific navigator configuration/name for the issue

- scroll_enabled : Bool (enable & disable Issue swipe)

Enable/disable scroll in the Issue Reader

- generate_page_detail_enabled : Bool (if the issue doesn't have page details in the Contents/disable extract Issue page detail from content)

Enable/disable generate page detail (id, title) when start reading issue

4. Double-check the format above then put this book.json file in the root folder.

5. Select all the files then compress all them to a .zip format.

6. Rename the .zip file to .hpub.

7. Upload the .hpub file to the MagLoft Portal.

Did this answer your question?