Project settings

What are project settings

Every articy:draft project allows to customize some general settings that affect details when working with the project. Project settings are divided into


 
When working in the multiuser scenario these settings apply to all team members that work with the project and can only be changed by an project administrator.

Project settings: "Journey"


Settings are hierarchical

There are three levels on which you can set parameter values:

  • Project settings: Set project-wide default values
  • Journey settings: Set parameter values for all slides of the presentation that inherit the journey's values
  • Journey point / slide settings: Override journey values for specific slides if desired

Generally, a slide (journey point) derives all default values from the presentation (journey), which again derives all default values from the project settings.




Project settings: Setting default values



To set project-wide default parameters for presentations, please go to the settings folder 1 in the navigator and switch to the journeys tab 2. On this tab you can specify values which will be used by all presentations in the project, given that they do not override this setting.





3 Setting: "Apply a gradient to the background color"

Each object in articy:draft can have a color. For example, in the flow editor or tiles views, you can click on flow fragments (and other story objects) and assign a color. A node's background color will become the slide background by default. Here you can specify whether you want to have a gradient or not. If gradients are switched off, articy:draft uses simple color fills as backgrounds.



4 Setting: "Background image"

You can set this parameter to the following values:
  • Choose default background image: The background image will be used for all slides (e.g. your corporate design background with logo), given that they do not override this parameter in their settings or in the journey settings.
  • Use preview image of node: A node's preview image will automatically become the slide background, given that this is not overriden in the slide's settings or the journey settings.

 
Just like you can assign a color to each object, you can also assign a so-called preview image to all objects. You can do that by either dragging an image asset onto an object's tile in the tile view, or you can open an opject's property sheet and assign the preview image. Go to a story node's property sheet 8 in the image below) and set a preview image there 9 in the image below), either by dragging&dropping an art asset onto the field or by right-clicking it and selecting "Choose target...". Once you've done that, the newly assigned preview image will become the slide's background image 10 in the image below) when you're viewing this story fragment in the presentation.






5 Setting: "Arrangement of background image"

This specifies how the background image shall be layouted:
  • Fit
  • Fill (recommended)
  • Stretch
  • Tile
  • Center



6 Setting: "Fade between journey points"

If this is set to "yes", there will be a smooth cross-fade between slides.



7 Setting: "Speed of auto-play"

Recorded presentations can be played back in "auto-play" mode, which means stepping through the slides automatically without any user interaction. Use this parameter to specify the number of seconds you want each slide to be displayed.



Journey settings: Customizing the presentation

Journeys (=presentations) have the same set of parameters as the defaults in the project settings described above. New journeys by default use all project-wide default values, but you can go to a journey's property page to adjust them. Changing values here will not reflect back to the project's default settings.

 
To access a journey's settings, just click on it in the navigator 11 in the image below). It will automatically open up in the property sheet view. There you should be able to locate the journey settings 12 in the image below).




Journey point settings: Customizing the slide

Journey points (=slides) have the same set of parameters as journeys and the defaults in the project settings, both described above. New journey points by default use all default values from the journey, but you can go to a journey point's property page to adjust them. Changing values here will not reflect back to the journey's default settings.

 
To access a slide's settings, switch to the property sheet view 13 in the image below) while you're looking at the slide you want to change.


Project settings: "Flow"



14 Setting: "Use built-in sripting support"

The built-in scripting support provides syntax highlighting and error validation for articy:expresso. This setting is auto-checked. The only reason to deactivate this setting is if you plan on using your own code in conditions, instructions, and pins, and handle export to a game engine yourself.

15 Setting: "Grid size"

The grid size option controls the size of the graph paper-like background present behind the elements in flow mode when the "Show grid" option is enabled. Grid size can be set to any number of pixels between 10 and 500, inclusive.



16 Setting: "Spacing"

The spacing option controls the automatic spacing provided between objects when multiple flow objects are created after right-clicking on an empty pin. Horizontal spacing and vertical spacing can be set separately to any number of pixels between 1 and 500, inclusive.

Project settings: "Multi-user"



In this tab some settings regarding handling of the repository can be made.

Enter a change message before publishing

Every time a partition is published, the user has the option to add a custom commit message that is sent along with the changed partition data to the repository/depot. By default, this behavior is enabled but it can be disabled by unchecking this setting.

Generate automatic change message

When publishing is set to also send a custom commit message to the repository/depot, articy:draft prefills this commit message by assembling a textual list of changes that have been performed since claiming the particular partition. While you can edit or even delete this prefilled commit message, you can also entirely deactivate the prefilling by unchecking this option.

Projects settings: "Text"

When working with spellchecking, you might want to change the used dictionary to the one of another language. You can do this in the "Text" project settings:


Usually, the "Text" tab of the project settings contains a small list of available languages but by clicking on the button "Additional languages..." 17 in the lower right corner you can open a list of even more available languages:



Check those languages you want to use for spellchecking and confirm with OK. All selected languages will automatically be downloaded to your computer and made available the purpose of spellchecking.

 
Language dictionaries are stored in %programdata%\Articy Software\Articy\3.x\Dictionaries. If you want to remove some of those dictionaries, just navigate with the Windows Explorer to this folder and delete them. You are always able to re-download deleted dictionaries like described above.

Project settings: "External applications"


Most development projects will rely on third-party applications for various editing tasks, and articy:draft makes integrating with these applications very straightforward. All applications added to the external application list will show up whenever right-clicking on any articy:draft object.

Adding external applications




To add an external application, click the "New entry" button 18. An empty entry will be created within the application list, which can then be configured as below.

Configuring external applications




There are a small number of options which must be set before an external application can be used. First, the "Menu entry" 19 item must be filled in, which determines the name which is displayed on the right-click context menu. Second, the path to the application itself 20 along with any desired command line options must be set. Finally, an optional "Working directory" 21 can be set which determines the present working directory for the application.

In addition to being able to simply run a program from the menu, articy:draft is capable of substituting in command line options containing various information about the selected object by using placeholder values 22. To use a piece of data a placeholder can provide, simply enter the corresponding placeholder text on the command line for your application. These placeholders are as follows:


{ExternalID} The (user-specified) external ID of the object. When you create a new object, this ID is empty but you can change it to your demands.

{TechnicalName} The technical name of the object like it is displayed at the bottom of every property sheet.

{Id} The main ID that was assigned to this object by articy:draft. It can never be changed! If you use the articy:draft API you can use this ID for object lookup. Also the XML export uses this ID.

{DisplayName} The name that is displayed for the object nearly everywhere throughout articy:draft.



This list of valid placeholders is supplied at the bottom of the menu, beneath the "New Entry" button.
 
Note that if an external program requires an {ExternalID} to run and the object that has been selected does not have one, its respective program launcher will be grayed out in the context menu.


Advanced menu entry options

For more advanced context menu entries you can add icons or create submenus.



To add an icon to a menu entry, you first have to import the icon (max. 128 x 128px) as asset into your articy:draft project. Then open the icon's property sheet (select it and press F8) and copy its Object ID from the bottom of the sheet. Now you can use the Object ID within the menu entry field of the external application settings as follows:
{Icon Object ID}Entry name

for example: {0x0100000000000112}Jira

To group menu entries you can create a submenu as follows:
Group name\Entry name

In this case you must make sure that all entries of this group start with exactly the same group name.

Example for a combined usage of icons and groups (as in the image above):
{0x0100000000000112}Jira\{0x0100000000000115}New Issue