Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Anchor
Project Settings
Project Settings
Project Settings

The Project Settings page (Project → Settings) has the configuration options that applies to the entire project.

Image Added

You can view and change the project settings that you configured when you created the project.

Project information

Field

Description

Description

A description for the project.

Project Path

Read-only path to the project.

Tag Count

How many tags the project has.

Communication Points

How many communication points the project has.

Target Platform and License

Field

Description

Target Platform

Shows the target platform selected in the project creation procedure.

Product Family

A basic description of the product families is

Enterprise — Complete FactoryStudio functionality

Edge HMI — Use for smaller applications and embedded systems.

Express — Use only for test or demonstration purposes.

IIoT Gateway — Create a project to work as an OPC server or Data Acquisition Gateway, providing data to other applications from the native protocol drivers.

Changing the family settings may cause some configurations to be invalid. For example, some features are only available in the Enterprise version.

Product Model

The product model is connected with the maximum number of real-time communication points you are allowed on that project.
Check Managing Licenses for more information.

Canary Historian


Project Options

Field

Description

Culture Info

Select the target language for the runtime application. This setting controls the formatting of dates, numbers, and other information so they are in compliance with the selected language. It is possible to change this setting later.

Allow Client Tasks (WPF only)


Enable Diagnostics Logging


Run Modules inside main Runtime process

Field

Description

Script Tasks


First Device Channel


Python Interpreter

Field

Description

Local


Server

Easy Heading Macro
headingIndent40
navigationTitleOn this page
selectorh2,h3
wrapNavigationTexttrue
navigationExpandOptiondisable-expand-collapse

Start on this line. Remove this sample content, and paste your own content.

Use this section to define and discuss the topic of the document and give any relevant information pertaining to the document.  

Heading 2 for a New Section

Sub-Section Header Using Heading 3

Below is a Horizontal Rule to help divide sections. Put these above new sections that start with a "Heading 2" Section Title. 

Section Header using Heading 2

Sub-Section Header Using Heading 3

It's essential to link from one page to another and to specific sections on a page. You can add any URL to a Confluence page and Confluence will automatically detect it and turn it into a link.

If you paste the URL for another page in your Confluence site, Confluence will display the link text as the page name and turn it into a relative link, meaning if the name of the page changes, Confluence will adjust the link so it doesn't break.

Topic Header using Heading 4

Add and Link to Anchors

The anchor macro allows you to create anchors in your documentation, which can be linked to or from anywhere. 

To add a macro and link to it from the same page:

  1. Type {anchor in the editor, select the anchor macro and give your anchor a name
  2. Select the text that'll link to the macro and hit Ctrl+K (Windows) or Cmd+K (Mac) (this opens the link dialog)
  3. Choose Advanced from the options on the left and type # followed by your anchor name

Check the Confluence documentation for more information on how to use links and anchors.

If you want to anchor or link, make sure you correctly anchor or  link to another page or to a specific line of the document. Add the anchor immediately above the corresponding section title and/or link to the correct word or section. 

Adding Images

Be sure when adding images that they are very clear, especially if they contain text, and try to only capture a close up of the important thing you are referencing.  You may need to overlay a few screenshots depending on what you are doing.  If you need help capturing what you need ask for assistance as a different capture tool may help immensely.

Use the "Insert files and images" tool at the top to insert an image.

Then, be sure to click the "Original" button, and the "Border" button.  The Original button will ensure the image is sized as the original, which should have be large enough to read clearly.  If needed, you can adjust the size after that, but larger is okay if it helps clarity.  The border button will put a box around the image to help delineate it from the white background, which is really useful on some screen shots that also have a lot of white on the edge.

Useful macros

Use macros when needed to help draw attention to particular information. Here's a few:

Tip, Note, Info, Warning, and Panel Macros

Often when creating documentation, there are elements of a page that you want to highlight or draw the the viewers' attention to. Confluence ships with the Tip, Info, Warning, Note and Panel macros, which will help you focus a viewer's attention on a particular part of your content.

Use the tip macro to give your readers handy hints!

Tip
titleTip Item

Here is an example Tip Item.

Info
titleInfo Item

Here is an example Info Item.

Warning
titleWarning Item

Here is an example Warning Item.

Note
titleNote Item

And this is a Note Item.

Panel
borderColordarkslateblue
bgColorWhite
titleColorWhite
borderWidth2
titleBGColordarkslateblue
borderStylesolid
titlePanel Title

Here is some text you want to point out. Perhaps some text the user should expect to see on the screen after performing some function or click.

Be sure to add a ">" symbol before a line that is representing a system prompt, and bold the text a user should enter such as this:

> Enter your name: Roberto

If you have a clear screen shot, add the picture in that clearly shows the relevant details.

Here is a Code Block - Specify the language you're showing (C#, VB.NET, JavaScript, Python, etc)

Code Block
titleCode Block Example
linenumberstrue
[Language: C#]


[Language: VB.NET]


Here is a table you can use.

...






In this section...

Page Tree
expandCollapseAlltrue
root@parent