Quark Author Web Edition 2015 System Administration Guide

Loading...

Quark Author Web Edition

2015 - February 2016

Update System

Administration Guide

CONTENTS

Contents

Introducing Quark Author configuration......................................

4

Smart Content Schema......................................................................................

4

New Smart Content type creation configuration.........................

5

Content type.....................................................................................................

5

Creation.....................................................................................................................

5

Auto-detection..........................................................................................................

5

Publishing..................................................................................................................

6

Indexing.....................................................................................................................

6

Document structure..........................................................................................

7

Configuration............................................................................................................

7

RelaxNG....................................................................................................................

8

Localized resources...................................................................................................

8

Editing canvas style configuration....................................................................

9

Workspace document instantiation.................................................................

10

Workspace.......................................................................................................

11

Publishing................................................................................................................

11

Multi-channel preview.............................................................................................

11

Advanced configuration for document instantiation..................

13

Configuration..................................................................................................

13

Workspace.......................................................................................................

13

New menu configuration.........................................................................................

13

Document template configuration..........................................................................

15

Document instantiation from pre-defined template configuration.........................

16

Document instantiation from browser template configuration...............................

16

Asset browser settings...................................................................................

17

Document save configuration.....................................................

19

Attribute mapping and revision settings........................................................

19

Revision settings......................................................................................................

19

Attribute mapping...................................................................................................

20

Auto save configuration..................................................................................

21

Smart content editor configuration............................................

22

Panel configuration.........................................................................................

22

Componentization...........................................................................................

23

Multi-channel preview.....................................................................................

24

ii | QUARK AUTHOR WEB EDITION 2015 - FEBRUARY 2016 UPDATE SYSTEM ADMINISTRATION GUIDE

 

CONTENTS

Smart Document pane configuration..............................................................

24

Asset browser configuration...........................................................................

25

Section Picker configuration............................................................................

26

Header configuration......................................................................................

27

Application settings........................................................................................

28

Editor toolbar configuration.......................................................

29

Keyboard shortcuts configuration...................................................................

29

Track changes and plugins configuration........................................................

30

Reference note configuration..........................................................................

31

Reference notes type configuration........................................................................

31

Reference notes styling configuration.....................................................................

31

Cross references configuration.......................................................................

32

Custom region configuration......................................................

33

Smart content editor reusable URLs..........................................

35

Legal notices...............................................................................

36

QUARK AUTHOR WEB EDITION 2015 - FEBRUARY 2016 UPDATE SYSTEM ADMINISTRATION GUIDE | iii

INTRODUCING QUARK AUTHOR CONFIGURATION

Introducing Quark Author configuration

Smart Content Schema

The Smart Content Schema version is 3.0. Any custom publishing process for Smart Content must point to this schema version. We suggest managing your own revisions to the schema as x.n, where x is the Quark version and n would reflect your own enumeration scheme.

4 | QUARK AUTHOR WEB EDITION 2015 - FEBRUARY 2016 UPDATE SYSTEM ADMINISTRATION GUIDE

NEW SMART CONTENT TYPE CREATION CONFIGURATION

New Smart Content type creation configuration

Content type

Creation

Create a new content-type using the Platform Web-Admin. To enable editing using Quark Author Web Edition, any new content type should be in a Platform content type hierarchy under "Smart Content".

Auto-detection

To configure the Platform Server to automatically detect the content type of the document being checked in from a local system to the Platform server and to automatically index new XML content type:

1Declare a new custom mime type corresponding to the XML content type by adding an entry in the {server}\ext\custom-xml-types-ext.xml file:

<mime-type type="application/xml; format=outbreak" sub-class-of="application/xml; format=smartcontent">

<xpath>/*[local-name()='section']/@type='OutbreakNotice'</xpath> </mime-type>

2Update the {server}\ext\content-mimetype-mappings-ext.xml file to map the content type with the custom mime type defined in step 1:

<content-type name="Outbreak Notice"> <mime-type>application/xml; format=outbreak</mime-type>

</content-type>

QUARK AUTHOR WEB EDITION 2015 - FEBRUARY 2016 UPDATE SYSTEM ADMINISTRATION GUIDE | 5

NEW SMART CONTENT TYPE CREATION CONFIGURATION

Publishing

The following sections describe how to configure Publishing Channels for documents of the new content type.

1To create new publishing channels to be used for multi-channel preview, indexing and publishing of a new content type, update the

{server}\ext\ChannelConfig-ext.xml file:

<channel id="OutbreakNoticeJpeg" name="OutbreakNotice.JPEG.ZIP" publishingProcess="smartDocToQxpRenderer" type="publish">

<param name="ASSET_ID" ask="true"/>

<param name="XSL_URI" ask="true"> classpath:OutbreakNotice 2QXPS.xslt</param>

<param name="QXP_TEMPLATE_URI" ask="true"> classpath:OutbreakNoticeTe mplate.qxp</param>

<param name="RENDER_FORMAT">JPEG</param> <param name="ANNOTATE_ERRORS">true</param> <param name="APPEND_ERRORS">true</param>

</channel>

<channel id="OutbreakNoticePdf" name="OutbreakNotice.PDF" publishingProcess="smartDocToQxpRenderer" type="publish">

<param name="ASSET_ID" ask="true"/> <param name="XSL_URI" ask="true">

classpath:OutbreakNotice2QXPS.xslt</param> <param name="QXP_TEMPLATE_URI" ask="true">

classpath:OutbreakNoticeTemplate.qxp</param> <param name="RENDER_FORMAT">PDF</param> <param name="ANNOTATE_ERRORS">true</param> <param name="APPEND_ERRORS">true</param>

<param name="OUTPUT_STYLE" ask="true">Default PDF Output Style</param> </channel>

<channel id="OutbreakNoticeHtml" name="OutbreakNotice.HTML.ZIP" publishingProcess="smartDocToHtmlRenderer" type="publish">

<param name="ASSET_ID" ask="true"/> <param name="XSL_URI" ask="true">

classpath:OutbreakNoticeToHTML.xslt</param>

</channel>

2To map the publishing channels with a new content type, update the

{server}\ext\PublishingConfig-ext.xml file:

<content-type name="Outbreak Notice" applyToChildContentTypes ="true"> <channelId>OutbreakNoticeJpeg</channelId> <channelId>OutbreakNoticePdf</channelId> <channelId>OutbreakNoticeHTML</channelId>

</content-type>

Indexing

To enable server side indexing for preview and thumbnail generation for documents of the new content type:

Add mapping of new content type with publishing channel to be used for indexing by editing the {server}\ext\indexingchannel-ext.xml file:

<contenttype-channel-mappings>

<mapping contenttype="Outbreak Notice" channel="OutbreakNoticeJpeg"/> </contenttype-channel-mappings>

6 | QUARK AUTHOR WEB EDITION 2015 - FEBRUARY 2016 UPDATE SYSTEM ADMINISTRATION GUIDE

NEW SMART CONTENT TYPE CREATION CONFIGURATION

Document structure

Configuration

Quark Author Web Edition editor configuration for a content type is loaded from a folder with the same name as that of the content type. This folder is located at:

{server}\webapps\workspace\editor\config

{content type}.rng : RelaxNG files describing specialization of smart content schema for a document of a content type. Used to validate generated XML and includes Section Types, Section Hierarchy, Para and other block types and Metadata. Different RelaxNG files can be created for Tags, Meta and Structure definition.

{content type}-resource_xx.xml : Files describing the language specific values of section and style names. Contains localized section names, block level and tag type names. Used for the placeholder text for section titles and also for the default (initial) text for the title and the body of sections.

{editor-content}.css : A CSS file defining styles applied on content during editing. Defines section specific styles in editing canvas and block and tag type specific canvas styling.

{editor-config}.js : A JavaScript file that overrides CKEditor default configurations like extra plugins, toolbar buttons etc. This is an optional file. If not present then the default configuration file is used.

{xmleditor-config}.xml : Quark Author Web Edition editor configuration. Used to enable and position the Action Panes, the Header and the buttons in the editor, set the Preview, Componentization and Plugins configuration and editor

QUARK AUTHOR WEB EDITION 2015 - FEBRUARY 2016 UPDATE SYSTEM ADMINISTRATION GUIDE | 7

NEW SMART CONTENT TYPE CREATION CONFIGURATION

settings. This is an optional file. If not present, then the default configuration file is used.

RelaxNG

The content type specific RelaxNG file defines the structure of a Smart Content document. This file also specifies different tags, block types, table types, list types and metadata that can be used in sections in the document.

Localized resources

The Outbreak Notice-Resources_en.xml file defines language specific values for Section and Style Names. Defines localized Section names, block level and Tag type names. Defines placeholder text for Section titles and the default (initial) text for Title and body of Sections.

<section type="OutbreakNotice" label="Outbreak Notice">

<title placeholder="[Document Title Placeholder]" default="Outbreak Notice Title"/>

<body default="Document Content"/> </section>

<section type="Synopsis" label="Synopsis">

<title placeholder="[Synopsis Title Placeholder]" default="Synopsis"/>

<body default="Synopsis Content"/>

</section><section type="Assessment" label="Assessment">

<title placeholder="[Assessment Title Placeholder]" default="Assessment"/>

<body default="Assessment Content"/>

</section><section type="Assessment Item" label="Assessment Item">

<title placeholder="[Assessment Item Title]" default="Assessment Item"/> <body default="Assessment Item Content"/>

</section><section type="Assessment Summary" label="Assessment Summary"> <title placeholder="[Assessment Summary]" default="Assessment Summary"/> <body default="Assessment Summary Content"/>

</section>

8 | QUARK AUTHOR WEB EDITION 2015 - FEBRUARY 2016 UPDATE SYSTEM ADMINISTRATION GUIDE

NEW SMART CONTENT TYPE CREATION CONFIGURATION

Editing canvas style configuration

The editor-content.css: File is a Cascading Style Sheet that defines CSS styles for the section title, body, table, ordered list, unordered list, para and Inline styles for a content-type.

.Synopsis .body , .Assessment .body , . Assessment_Item , . Assessment_Summary

{ padding-left : 18px ;}

.title {

font-size : 26.0pt ;

font-family : " Calibri","sans -serif" ; color : #4f81bd ;

text-transform : uppercase ; padding-bottom : 4px ;}

.Assessment .subtitle , .Synopsis .subtitle , .Recommendations .subtitle { background : #4f81bd ;

color : white ; padding-top : 3px ; padding-bottom : 3px ;}

.Assessment_Summary .subtitle { font-size : 11.0pt ; font-weight : bold ; font-style : italic ;

color : #333 ; background : #dbe5f1 ; }

QUARK AUTHOR WEB EDITION 2015 - FEBRUARY 2016 UPDATE SYSTEM ADMINISTRATION GUIDE | 9

NEW SMART CONTENT TYPE CREATION CONFIGURATION

Workspace document instantiation

Use the workspace-config.xml file found here:

{server}\webapps\workspace\WEB-INF\classes\ to configure content types for document creation via the Platform Workspace using the

DocumentCreationSettings.

id: Specifies a unique id for the setting.

contentType: Specifies the name of the platform specific content type of the created asset.

enableNew: Enables the creation of an asset using the New menu in the workspace. The default value is true.

enableNewFromTemplate: Enables the creation of an asset from a template. The default value is true.

assetBrowserId: Specifies the unique ID indicating a particular

AssetBrowserSetting to be used for filtering assets in the New Document from Server Template dialog. See the Document instantiation from browser template configuration section for a usage example.

starterTemplate: Set this attribute to enforce the creation of a new asset by automatically using an existing asset as a template. The value is a URI to a platform asset to be used as the template. The value should be specified in the form qpp://assetsbypath/[AssetPath] or qpp://assets/[AssetId]

<DocumentCreationSettings>

<DocumentCreationSetting id="new_qcd_menu_item" contentType="CopyDesk Article"

assetBrowserId ="QUARKCOPYDESK_BROWSER" type="QCD"/> <DocumentCreationSetting id="new_qxp_menu_item" contentType="QuarkXPress

Project"

assetBrowserId ="QUARKXPRESSPROJECT_BROWSER" type="QXP"/> <DocumentCreationSetting id="new_smart_doc_menu_item" contentType="Smart

Document"

assetBrowserId ="SMARTDOC_BROWSER" type="XML"/> <DocumentCreationSetting id="new_smart_section_menu_item"

contentType="Smart Section"

assetBrowserId ="SMARTSECTION_BROWSER" type="XML "/> <DocumentCreationSetting id="new_outbreak_menu_item" contentType="Outbreak Notice"

assetBrowserId ="OUTBREAK_BROWSER " type =" XML" enableNew

="true"/>

</DocumentCreationSettings>

10 | QUARK AUTHOR WEB EDITION 2015 - FEBRUARY 2016 UPDATE SYSTEM ADMINISTRATION GUIDE

NEW SMART CONTENT TYPE CREATION CONFIGURATION

Workspace

Publishing

To enable publishing channels in the workspace, in the

{server}\webapps\workspace\WEB-INF\classes\Workspace-Config.xml file:

Add names of the new publishing channels to the value of the enabledPublishingChannels key.

<Add key="enabledPublishingChannels" value="qxpPdf;qxpEpub;qxpAppStudio;qxpAppStudioPackage;busDocPdf;busDocHtml;busDocQxp;

busDocAppStudio;busDocAppStudioPackage;ditaDocTransformation;smartDocPdf;smartDocHtml;

smartTableHtml;smartTablePdf;OutbreakNoticeJpeg;OutbreakNoticePdf;OutbreakNoticeHtml"/>

Multi-channel preview

To enable multi-channel preview for the "Outbreak Notice" content type , in the

{server}\webapps\workspace\WEB-INF\classes\Workspace-Config.xml file::

Add new channel mapping by adding the following content:

<ChannelMapping contentType="Business Document" applyToChildContentTypes="true">

<Channels>

QUARK AUTHOR WEB EDITION 2015 - FEBRUARY 2016 UPDATE SYSTEM ADMINISTRATION GUIDE | 11

+ 25 hidden pages