Skip to content

Commit

Permalink
Add support for Spectrum-CSS, and add “Refresh”.
Browse files Browse the repository at this point in the history
  • Loading branch information
jenstroeger committed Jun 22, 2019
1 parent 8f5f454 commit da80be7
Show file tree
Hide file tree
Showing 33 changed files with 1,687 additions and 428 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ This repository contains the complete source code for [Bookalope](https://bookal

## Requirements

The extension requires and supports Adobe InDesign versions 11–13. However, the extension may run on older versions that provide CEP support, but that hasn’t been tested.
The extension requires and supports Adobe InDesign versions 11–14. However, while the extension may run on older versions that hasn’t been tested in depth.

## Coding

Read a general introduction to writing an Adobe CEP extension [here](http://www.adobe.com/devnet/creativesuite/articles/a-short-guide-to-HTML5-extensions.html). For more information on the Bookalope API please refer to its [documentation on Github](https://github.com/jenstroeger/Bookalope).
Read a general introduction to writing an Adobe CEP extension [here](http://www.adobe.com/devnet/creativesuite/articles/a-short-guide-to-HTML5-extensions.html), and a more in-depth documentation provides the [CEP Extension Cookbook](https://github.com/Adobe-CEP/CEP-Resources/blob/master/CEP_9.x/Documentation/CEP%209.0%20HTML%20Extension%20Cookbook.md). For more information on the Bookalope API please refer to its [documentation on Github](https://github.com/jenstroeger/Bookalope).

InDesign does not load an extension unless the extension has been cryptographically signed. Therefore, in order to run the Bookalope extension from source, you need to switch InDesign to _PlayerDebugMode_:

- On Mac, open the file `~/Library/Preferences/com.adobe.CSXS.8.plist` and add a row with key `PlayerDebugMode` of type String and value `1`. You can edit `.plist` files using [Xcode](https://developer.apple.com/xcode/), [PList Edit](https://www.fatcatsoftware.com/plisteditpro/) or other applications suited to edit [Property Lists](https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/PropertyLists/Introduction/Introduction.html).
- On Windows, using its [registry editor](https://support.microsoft.com/en-au/help/4027573/windows-open-registry-editor-in-windows-10) open the registry key `HKEY_CURRENT_USER/Software/Adobe/CSXS.8` and add a key named `PlayerDebugMode` of type String and value `1`.
- On Mac, open the file `~/Library/Preferences/com.adobe.CSXS.9.plist` and add a row with key `PlayerDebugMode` of type String and value `1`. You can edit `.plist` files using [Xcode](https://developer.apple.com/xcode/), [PList Edit](https://www.fatcatsoftware.com/plisteditpro/) or other applications suited to edit [Property Lists](https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/PropertyLists/Introduction/Introduction.html).
- On Windows, using its [registry editor](https://support.microsoft.com/en-au/help/4027573/windows-open-registry-editor-in-windows-10) open the registry key `HKEY_CURRENT_USER/Software/Adobe/CSXS.9` and add a key named `PlayerDebugMode` of type String and value `1`.

If you have multiple CSXS versions installed, add the `PlayerDebugMode` to all of them.

Expand Down Expand Up @@ -61,13 +61,13 @@ Then start InDesign, and the extension should be available from the _Window →

Once installed, open the extension panel:

<img src="https://bookalope.net/img/idsn-bookalope-upload.png" width="50%" alt="Bookalope InDesign: Upload panel">
<img src="https://bookalope.net/img/idsn-bookalope-0.9.6-upload.jpg" width="50%" alt="Bookalope InDesign: Upload panel">

To use the Bookalope web services, you need a Bookalope API key: you can find the key in the [user profile](https://bookflow.bookalope.net/profile) of your Bookalope account. Then select a book manuscript in Word format (or any other of the [supported document formats](https://github.com/jenstroeger/Bookalope/blob/master/API.md#get-formats)), fill in `Name` and `Author` of the book, and then click the `Upload and convert` button.

The extension uploads the document to the Bookalope server for analysis and conversion. This can take a little while. Once finished, the extension downloads the converted file, creates a new InDesign document, and places the downloaded content into the new InDesign document. The extension’s panel changes now to this:

<img src="https://bookalope.net/img/idsn-bookalope-update.png" width="50%" alt="Bookalope InDesign: Update panel">
<img src="https://bookalope.net/img/idsn-bookalope-0.9.6-update.jpg" width="50%" alt="Bookalope InDesign: Update panel">

From here, you can open the document on the Bookalope website to revisit and adjust the entire analysis and conversion flow (watch the video tutorials on [Youtube](https://www.youtube.com/channel/UCCxR_k6G06qEAj3IjZ9AcoQ)). You can also download the converted document in EPUB, MOBI, or print-ready PDF formats.

Expand All @@ -80,4 +80,4 @@ Writing an Adobe CEP extension requires documentation which is not always readil
- Davide Barranca’s [blog](https://www.davidebarranca.com/category/code/) contains useful tips;
- Adobe CEP extensions’s UI should be styled using [CEP Spectrum Boilerplate](https://github.com/Hennamann/CEP-Spectrum-Boilerplate) or [Topcoat](https://github.com/topcoat/topcoat).

In addition to the above, the [InDesign Scripting Forum](https://forums.adobe.com/community/indesign/indesign_scripting) might be useful, or the [#cep channel on Slack](https://adobedevs.slack.com/messages/C1FKLQ63F) is a playground to many experienced developers.
In addition to the above, the [InDesign Scripting Forum](https://forums.adobe.com/community/indesign/indesign_scripting) might be useful, or the [#cep channel on Slack](https://adobedevs.slack.com/messages/C1FKLQ63F) is a playground to many experienced developers.
18 changes: 9 additions & 9 deletions extensions/Bookalope/CSXS/manifest.xml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<ExtensionManifest Version="5.0" ExtensionBundleId="com.bookalope" ExtensionBundleVersion="0.9.3" ExtensionBundleName="Bookalope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ExtensionManifest Version="5.0" ExtensionBundleId="com.bookalope" ExtensionBundleVersion="0.9.6" ExtensionBundleName="Bookalope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Author>Jens Troeger, Bookalope</Author>
<Abstract>Adobe CEP extension for InDesign to use the Bookalope cloud services.</Abstract>
<ExtensionList>
<Extension Id="com.bookalope.panel" Version="0.9.5" />
<Extension Id="com.bookalope.panel" Version="0.9.6" />
</ExtensionList>
<ExecutionEnvironment>
<HostList>
<Host Name="IDSN" Version="[11.0,13.9]" />
<Host Name="IDSN" Version="[11.0,14.9]" />
</HostList>
<LocaleList>
<Locale Code="All" />
Expand All @@ -32,16 +32,16 @@
<Menu>Bookalope</Menu>
<Geometry>
<Size>
<Width>400</Width>
<Height>260</Height>
<Width>450</Width>
<Height>450</Height>
</Size>
<MinSize>
<Width>400</Width>
<Height>260</Height>
<Width>450</Width>
<Height>450</Height>
</MinSize>
<MaxSize>
<Width>400</Width>
<Height>260</Height>
<Width>450</Width>
<Height>800</Height>
</MaxSize>
</Geometry>
<Icons>
Expand Down
Loading

0 comments on commit da80be7

Please sign in to comment.