# Shortcode

Flipbook is added to page or post via shortcode. The default shortcode is

`[real3dflipbook id="123"]`

Flipbook can be cistomized directly with shortcode parameters. For example you can show a PDF as flipbook simply with 

`[real3dflipbook pdf="https://...pdf"]`

Or you can set flipbook mode to lightbox and make the lightbox opened on page load with

`[real3dflipbook id="123" mode="lightbox" lightboxopened="true"]`

Here is the list of supported shortcode parameters:

| Name                 | Dsscription                                                      |
| -------------------- | ---------------------------------------------------------------- |
| `id`                 | Embed flipbook by ID. To show all flipbooks use `id="all"`       |
| `name`               | Embed flipbook by name                                           |
| `pdf`                | PDF file URL                                                     |
| `mode`               | `normal, lightbox or fullscreen`                                 |
| `class`              | CSS class that will open the flipbook lightbox                   |
| `aspect`             | Flipbook container aspect ratio, for example 1.77 or 1.33 or 0.7 |
| `thumb`              | Lightbox thumbnail image URL                                     |
| `title`              | Flipbook title for lightbox                                      |
| `viewmode`           | `webgl`, `3d`, `2d`, `swipe`, `scroll` or `simple`               |
| `lightboxopened`     | Lightbox opened on page load                                     |
| `lightboxfullscreen` | Open lightbox in fullscreen                                      |
| `lightboxtext`       | Text that will open flipbook lightbox on click                   |
| `hidemenu`           | Hide flipbook toolbar                                            |
| `autoplayonstart`    | Enable autoplay                                                  |
| `autoplayinterval`   | Autoplay interval in ms                                          |
| `autoplayloop`       | Enable autoplay loop                                             |
| `zoom`               | Initial zoom                                                     |
| `zoomdisabled`       | Disable zoom                                                     |
| `btndownloadpdfurl`  | URL for Download PDF button                                      |
| `thumbcss`           | Custom CSS for lightbox thumbnail image                          |
| `containercss`       | Custom CSS for flipbook container                                |
| `singlepage`         | Enable single page mode                                          |
| `startpage`          | Open flipbook at specific page                                   |
| `pagenumberoffset`   | Offset flipbook page 1                                           |
| `deeplinkingprefix`  | Enable deep linking and set custom prefix                        |
| `search`             | Show search                                                      |
| `pages`              | Array of pages, image URLs for flipbook                          |
| `thumbalt`           | Alt attribute for thumbnail image                                |
| `category`           | Show flipbooks from category                                     |
| `author`             | Show flipbooks from author                                       |
| `num`                | Number of flipbooks to show                                      |
| `order`              | `ASC` or `DESC`                                                  |
| `orderby`            | `title` or `date`                                                |
| `pagerangestart`     | Strat flipbook from specific page                                |
| `pagerangeend`       | Show flipbook until specific page                                |
| `previewpages`       | Show flipbook in preview mode                                    |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://real3dflipbook.gitbook.io/wp/shortcode.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.