StepShot User GuideStepShot Team

StepShot is an intuitive and powerful utility that lets you create detailed step-by-step procedure guides andmanuals. Imagine documenting and editing each step of the workflow procedure until it looks and reads perfectly, thencombining it all together and exporting as a document that's available to everyone!

Table of ContentsOverview 4

Introduction 5It's really that simple. It's StepShot! 5Understanding StepShot basics 5

Quick info about Articles and Manuals 6

Tuning up your experience 8How to use Hotkeys? 8Capturing Settings 9Other Settings 9

Managing your export/publish accounts 10Miscellaneous 12

Changing default Workspace location 12

Quick Start 13Working with Articles 14

How to use Article? 14How to move/copy Article to a Manual? 14

Understanding Article edit window 16Changing Article metadata 16Saving Article into another location 17Article Export & Publish 17

Working with Manuals 18How to use Manuals? 18Understanding Manual 19

How to work with Articles in a Manual? 19What is a Draft? 20

How to share a Manual? 21

Recording in nutshell 22Quick screen capture 22Screen Capture 22

Recording (1) 22Recording Types 22Standalone Screenshot (2) 22

Image Processing 23Copying/Saving an image 23How to replace an image for the captured step? 24

Sharing files 24How to share step image with someone? 24

Export & Publish 25Exporting 26

How to export a document? 26Export formats 27

What formats are supported by StepShot? 27

What formats are supported by StepShot? 27How to export images? 30

Publish to Confluence 31Connecting Confluence portal to StepShot 31

Configuring Confluence account 31Adding Confluence account into StepShot 32

How to publish to Confluence? 34Selecting destination page where to publish a document 34Navigate to the published document 35

Publish to easyDITA 35Connecting StepShot to easyDITA 36How to publish to easyDita? 37

Selecting file and assets folder destination where to deploy an easyDITA document to 38

FAQ 38How to change the destination to another repository, when file and assets folder havealready been chosen?

38

How to create custom template? 39Overview 39

What is a template? 39Complex templates 39

Getting started 39Where are templates located? 39Template configuration file 40

Creating Word template 41Replaceable keywords inside the *.docx 42Layout keywords inside the *.docx 43Customizing the *.docx 43

Creating XML-based templates (HTML, DITA etc) 44What is an XML template? 44Schema for xslt transformation 45

Creating Html templates 46What is an HTML template? 46

Creating PDF template 46What is a PDF template? 46

Overview

IntroductionStepShot Team

It's really that simple. It's StepShot!

StepShot is an intuitive and powerful utility that lets you create detailed step-by-step procedure guides andmanuals. Imagine documenting and editing each step of the workflow procedure until it looks and reads perfectly, thencombining it all together and exporting as a document that's available to everyone!

Understanding StepShot basics

Workspace is a virtual space where all your articles and manuals are stored. The idea of such a workspace is toimprove your productivity and let you easily find the recently saved documents with no need of looking for them ina heap of folders.

Quick info about Articles and Manuals

Quick info about Articles and Manuals

Article is a document with text and steps documentation. Articles menu contains the list of all articles created in StepShot application.

Manual combines Articles grouped by chapters. Manual can be exported and published as one document. Manuals menu contains the list of all Manuals created in StepShot application.

Multiple Articles can be opened to work on them simultaneously.

Tuning up your experience

Tuning up your experience

Manage all kind of settings to tune up you work experience with StepShot.

How to use Hotkeys?

Add separate screenshots to your workflow using the hotkey combinations.

Note: So as not to confuse you, Hotkeys work when only one Article window is open.

Capturing Settings

Capturing Settings

Use "Highlight cursor" option to show a highlighted ellipse around the cursor in captured screenshot.

"Extend active window size" adds the given range of pixels to a selected region or captured window. This feature isvery useful when used in pair with "Blur extended edges" option. Blurring the edges makes your screenshots lookmore solid and proficient.By default StepShot captures only mousedown events. But in case you want to record actions like drag'n'drop - youmight want to consider an option "Capture mouse up after mouse down". When enabled, it allows mouseup to becaptured as a separate screenshot once the set timeout is reached. Quite often you might need to filter someparticular clicks and to do that you can select one of the filtering options. By default all the screenshots are captured,however additionally you can capture mouse clicks only if particular keyboard button is pressed or not pressed.Left and Right click to capture delay initiate a screenshot with a timeout before the actual screenshot is taken.By default, screenshot capturing is initiated right after the mouse button is clicked.

Other Settings

Managing your export/publish accounts

Managing your export/publish accounts

It is easy to quickly share your documents directly from StepShot - just add external service accounts.

Specify comprehensible names for all your accounts and they will be displayed in StepShot when you are sharingdocuments or images.

For adding your Dropbox account just follow steps shown in the dialog below.

Miscellaneous

Miscellaneous

Changing default Workspace location

After you installed StepShot, it creates Workspace folder at a default location on your PC. To change it, just press"Move" and select a new folder for your Workspace. All your current Articles and Manuals will be moved to thatlocation.

Note: If you are using external drive for workspace location, do not forget to insert that device before openingStepShot.

Quick Start

Working with ArticlesStepShot Team

Article is a single document that can be shared or be a part of a Manual.Articles menu have Articles that you want to share but which aren't a part of a Manual. You can copy or move anArticle into an existing Manual at any time.

How to use Article?

As you open "Articles" menu (1), you will access all Articles that are in your Workspace. You can also add a newarticle (2) or change the existing one (3).

How to move/copy Article to a Manual?

Articles could be copied or moved to a Manual. Just use "Move to Manual..." or "Copy to Manual..." context menuoptions.

Press "Move to manual..." in the Article context menu, choose Chapter you want to move the Article into. Thisoperation will remove this Article from the Articles menu list and add it to the indicated Chapter.

"Copy to Manual..." makes a standalone copy of that Article. The modification of one Article wont change its copy.

Understanding Article edit window

Understanding Article edit window

Open menu (1) to be able to save this document to another location, share or publish it somewhere on yourcomputer or remote service.

To create your documentation, use recording buttons (2) (discussed in "Recording" article later). All recorded stepsand single screenshots are displayed in the outline panel (3).To group steps into sections, right click on empty space inside the outline panel and click on "Add section" option.

Annotate the selected step image (5) with drawings (7). Then update step title and description (6) to tell the userwhat he/she needs to do.

Changing Article metadata

To rename an Article, right click on the Articles name and set a new one.

Author and description fields can be also exported into a final document. So leave some useful abstract for the

currently edited Article.

Saving Article into another location

It's possible to save an Article into your Workspace or somewhere on your computer.

To save the Article somewhere inside the Workspace, click on Save to Workspace, set the name for the Article inthe opened dialog and choose the location where to save it.

Article Export & Publish

Export & Publish functionality is described later in the manual.

Working with Manuals

Working with ManualsStepShot Team

Manual groups Articles into one document that can be easily shared. Manuals menu contains all created manuals.

How to use Manuals?

Manuals menu lists all Manuals in the Workspace. Recent list shows last Articles you have worked on.

Understanding Manual

Understanding Manual

"Info" page has all metadata info for a Manual. To rename the Manual, right click on its name and set a new one.It is possible to apply authors name to all Articles included in the Manual.

"Articles" page (2) has all articles inside the Manual.

Export (3) and Publish (4) pages will be described in "Export & Publish" chapter later in the manual.

How to work with Articles in a Manual?

Go to "Articles" page in a Manual.

Articles are grouped into Chapters. Use contextual menu for Chapter and Article to either add new ones or changesettings for the existing ones.

What is a Draft?

Marking Article as Draft will prevent it from being included in the exported/published document.

Use contextual menu for Article to mark it as Draft.

How to share a Manual?

Export a package to file via "Export to Package..." button in Info tab, and send the saved file to someone. Theperson youve sent it can import the package into ones Workspace clicking at "Import..." button in Manuals menu(see below).

Recording in nutshell

Recording in nutshellStepShot Team

Quick screen capture

If you are in hurry, and want to make a quick document to share with someone, use Quick screen capture buttons.By doing that, you will automatically create an Article inside "Articles" menu and the recording will start.

Screen Capture

Recording (1)

Recording options allow you to take the sequence of screenshots without the interruption. Just press one of therecording types available. And start doing steps that you want to record. After you are done with recording, pressStop button in the Recording dialog.

Recording Types

Screen recording takes a screenshot of the whole active screen. The active screen is determined by the mouseposition*.

*This is applicable only for a multi-monitor environment.

Window recording captures the active window, i.e. the one that holds the focus. Usually the process you arerecording does not require capturing the full screen images to explain particular workflow details. You can also useit when you want to save some space. To start active window recording you need to press "Window" in the Screencapture section.

Region recording allows you to set the recorded region around the cursor, capturing this way only relevantinformation. You can also modify the size of the region in the Recording dialog.

Region screenshot allows you to select manually the region you are going to capture. Select region or just pointmouse on top of the desired window, then click on it or press "Enter" key to take a screenshot.

To change capture Settings or Hotkeys, refer to the Introduction article above.

Image Processing

Use Drawing tools to annotate the selected step image with various shapes and lines. Blur out the information youdon't want others to see or use crop tool to show only relevant information on a screenshot.

Tip: double click on a shape to edit text in it.

Copying/Saving an image

Copy (1) a selected step image into the clipboard or save it (2) into a jpeg file.

How to replace an image for the captured step?

How to replace an image for the captured step?

Replace menu allows you to change the current image with an image in the clipboard, an image file or a newscreenshot. You can also remove the image for the captured step.

Sharing files

How to share step image with someone?

Screenshots can be shared from the Current image section.

You can either upload a screenshot directly to online services or create a new email with the image attachment. Linkto the uploaded file will be automatically placed into the clipboard. Refer to the Introduction article for moredetails on how to add online services.

Note: if you don't have an email client installed on your computer, you won't be able to share screenshots via email.

Export & Publish

ExportingStepShot Team

StepShot supports the following formats for export: Word, XML-based (HTML, DITA, etc.) and PDF. Each output file iscustomizable via templates. You can easily export Manuals and Articles with StepShot.

How to export a document?

Manual and Article export flows are similar. Just go to "Export" tab in the Manual or the same tab in the openedArticle window (see image below).

You will be able to choose the necessary export file format there. Choose the template (1) and set export settingssuch as quality and image size (2). Then export the document (3) to a specific location.

Export settings are the same for all export formats.

Copy file path (1) or open file/destination folder (2) when export is completed.

Export formats

What formats are supported by StepShot?

StepShot supports exporting to Word document, XML-based formats as DITA, HTML, etc. and PDF.

It is that simple!

Each export format has the set of the preconfigured templates which can be selected in a dropdown beforeexporting. You can also create your own templates and add them to StepShot. Adding custom templates will be described laterin the manual.

So, choose the template you want your article to look like, set the image quality and size. By the way, last ones havea tremendous effect on the final document size.

After preconfiguration is done, hit "Export" button and choose the output file location.

Such multiple files formats, as XML, DITA, HTML will create Assets folder with all images and template assets.

How to export images?

Go to "Export As Images" tab to save the necessary images into a specific location.

Publish to ConfluenceStepShot Team

Publishing either Article or Manual to Confluence is now really easy with StepShot!

Connecting Confluence portal to StepShot

Configuring Confluence account

To be able to publish documents to your Confluence portal, you have to configure your Confluence instance first.Since administrative privileges are required for this, ask your support team for a help, if you don't have ones. So you need to navigate to General configuration menu on Confluence portal.

Then go to "Further Configuration" menu.

Find "Remote API" option and make sure that checkbox is checked. This will allow StepShot to communicate withthe Confluence portal.

Adding Confluence account into StepShot

Set your credentials (1) and (2) to your Confluence portal. You can get "Server Base URL" (3)at "GeneralConfiguration" page in Confluence Admin as shown below.

Pressing "Add account" button will check your credentials, if successful, it will connect StepShot with Confluenceportal and you will be able to publish documents to this account.

Refer to the first step in this article on how to get to General Configuration page in Confluence portal.

How to publish to Confluence?

How to publish to Confluence?

Choose Confluence account (1), then select the destination page for your document (2) (dialog is shown below). Set the output template (3) and output image quality* (4).

*Lower quality will speed up the deploying time to Confluence.

Then hit Publish button (5) and wait till StepShot deploys your document to Confluence. (Note: the deploying time depends on your internet connection and the final document size).

Selecting destination page where to publish a document

The browse dialog will provide you with all spaces and pages created for your Confluence account. If there is no

applicable page, just create one by right clicking on parent page and choose "New page" option from context menu.

Now, when you have the page where you want to publish the document to, click Ok button (2) in the browsedialog.

Navigate to the published document

After publishing is finished, copy link (1) and open it in your browser or just click on "Open link" button (2).

Publish to easyDITAStepShot Team

Publishing either Article or Manual to easyDITA is that easy as well.

Connecting StepShot to easyDITA

Connecting StepShot to easyDITA

Create an account at http://easydita.com.

After the successful registration add easyDITA account to StepShot.

Host name is the project link you get after you have logged into easydita.com. (copy it from browser address field). For example, http://{projectname}.t4.easydita.com.

Click on "Add account" and StepShot will check your account credentials. If successfully added, you can use youreasyDITA account to publish your documents to it.

How to publish to easyDita?

How to publish to easyDita?

Publishing to easyDITA is as easy as publishing to Confluence.

Choose easyDITA account (1), then select the destination file for your document (2) and assets folder (3). Assets folder contains all images and template assets that go together with the published document.

If you are publishing a Manual, all Chapters and Articles files are deployed to it. These files are referenced byManual .dita file.

Setting an assets folder is optional. Leave autogeneration checked for StepShot to automatically create assets folderfor you. Folder name will have "_Assets" suffix following the file name you have selected previously. Note: filelocation and assets folder location should be in the same repository.

Set the output template (4) and output image quality* (5).

*Lower quality will speed up the deploying time to easyDITA.

Then hit Publish button (6) and wait till StepShot deploys your document. Note: the deploying time depends on your internet connection and the final document size.

Selecting file and assets folder destination where to deploy an easyDITA

Selecting file and assets folder destination where to deploy an easyDITAdocument to

The browse dialog will show you all repositories that you have in your easyDITA account. Choose the file or folderthat already exists or right click on any item to create a new page or folder.

After publishing is finished, copy link (1) and open it in your browser or just click on "Open link" button (2).

FAQ

How to change the destination to another repository, when file and assetsfolder have already been chosen?

Sometimes you need to change the publishing repository after file and assets folder locations have been alreadychosen. To do it, check "Autogenerate assets folder" option, change the file location and then uncheckautogeneration option back and set a new assets folder location.

How to create custom template?

How to create custom template?StepShot Team

It describes how to create your own template that can be used for exporting and publishing your documents.

Overview

What is a template?

The StepShot template system provides different ways for exporting content into the variety of custom formats.Customizing existing or creating new templates allows you to share your documents in the format of yourcompany.

Complex templates

If you want to use complex corporate templates, you can contact StepShot representatives to create a customizedexport StepShot template based on your requirements.

Getting started

Where are templates located?

The default templates are located in the directory where StepShot is installed. Usually, it is C:\\ProgramFiles\StepShot_v3\templates. Note: Do not change these templates. If you want to make a custom one, just copy the necessary template to theUser templates folder.

User templates are located in your PC Documents folder. Go to Start (1) -> Documents (2) -> StepShot ->Templates. This is the place for your customized templates.

Template configuration file

Each template has config.xml file, which has all references to the actual template files and template metadata that isused to export a document.It can be opened via any text editor (like Notepad). We recommend using Notepad++ since it highlights the syntaxof the file.

Article node (1) is used to configure a template for the export of Articles that are not the part of a Manual. Manual node (2) is used to configure a template for manual export.

Different export formats have different parameters in the nodes which will be described later.

Creating Word template

To create a custom Word template, go to User templates folder. Create new "Word" folder unless there are some.

Copy one of the Word system templates to the newly created folder.

Go to that copied folder and open config.xml file. Find "name" attribute and change it to another template name.That value will show up in the list of templates at Word exporting page.

article.docx file is used for exporting Articles that are not the part of a Manual.manual.docx file is used to export Manuals.

To configure max image size, find "image" tag and change max_width and max_height to the necessary values (e.g.,in px).

"template" and "preview" have relative paths to templates and preview images.

Replaceable keywords inside the *.docx

Replaceable keywords inside the *.docx

Replaceable keywords will be replaced with your document metadata during the export:

{ArticleTitle} - article title {ArticleAuthor} - author name {ArticleDescription} - article description

Layout keywords inside the *.docx

Layout keywords inside the *.docx

There are the following layout keywords in the export document template:

- StartSectionLayout-StartStepLayout: The content between these two layout keywords will be processed byStepShot and appended to the document at the start of each section. SectionTitle keyword is a replaceableplaceholder keyword. It will be replaced with the real document section title in the output document.

- StartStepLayout-EndSteplayout: The content between these two layout keywords will be processed by StepShotand appended to the document for each step in the document. StepTitle/StepDescription/StepImage are self-descriptive.

- EndStepLayout-EndSectionLayout: will be placed at the end of each section.

Customizing the *.docx

The described replaceable layout keywords enable you to create templates of any complexity. Just set the keywordsin the correct place and edit them as you like. After you have finished editing the template - just restart StepShot and see how your new template automaticallygot into the list of available ones. Enjoy!

Creating XML-based templates (HTML, DITA etc)

Creating XML-based templates (HTML, DITA etc)

What is an XML template?

The primary use of XML templates is to create HTML content. However, templates can be customized to create anytype of content that is text-based. You might use it to create a custom template to export to Dita, Markdown or otherformats. The same template engine works for easyDITA and Confluence templates.

To make an output file XSLT, transformation is used.

article/article.xslt has xslt transformation that is used to generate an output file for an Article;

manualTemplate node has xslt transformation that is used to generate an output file for a Manual;chapterTemplate node has xslt tranformation that is used to generate an output file for a Chapter [optional]; articleTemplate node - has xslt transformation that is used to generate an output file for an Article [optional];

Schema for xslt transformation

Schema for xslt transformation

Look at xml templates provided by StepShot to see how to use this schema in a template.

Creating Html templates

Creating Html templates

What is an HTML template?

HTML templates use the same XSLT transformations as XML use.

With an HTML template you can also include assets that will be copied together with the exporting document. Use"assets" node for that.

Creating PDF template

What is a PDF template?

A PDF template is similar to an HTML template. PDF engine uses xslt files to create html representation of adocument, with further conversion into a PDF file.

Use "cover" attribute to specify xslt template file for the first page of a .pdf document. "toc" is used to generateTable of Content page that follows the cover page."cover" and "toc" attributes are optional.

Table of ContentsOverviewIntroductionIt's really that simple. It's StepShot!Understanding StepShot basicsQuick info about Articles and Manuals

Tuning up your experienceHow to use Hotkeys?Capturing SettingsOther Settings

Managing your export/publish accountsMiscellaneousChanging default Workspace location

Quick StartWorking with ArticlesHow to use Article?How to move/copy Article to a Manual?

Understanding Article edit windowChanging Article metadataSaving Article into another locationArticle Export & Publish

Working with ManualsHow to use Manuals?Understanding ManualHow to work with Articles in a Manual?What is a Draft?

How to share a Manual?

Recording in nutshellQuick screen captureScreen CaptureRecording (1)Recording TypesStandalone Screenshot (2)

Image ProcessingCopying/Saving an imageHow to replace an image for the captured step?

Sharing filesHow to share step image with someone?

Export & PublishExportingHow to export a document?Export formatsWhat formats are supported by StepShot?How to export images?

Publish to ConfluenceConnecting Confluence portal to StepShotConfiguring Confluence accountAdding Confluence account into StepShot

How to publish to Confluence?Selecting destination page where to publish a documentNavigate to the published document

Publish to easyDITAConnecting StepShot to easyDITAHow to publish to easyDita?Selecting file and assets folder destination where to deploy an easyDITA document to

FAQHow to change the destination to another repository, when file and assets folder have already been chosen?

How to create custom template?OverviewWhat is a template?Complex templates

Getting startedWhere are templates located?Template configuration file

Creating Word templateReplaceable keywords inside the *.docxLayout keywords inside the *.docxCustomizing the *.docx

Creating XML-based templates (HTML, DITA etc)What is an XML template?Schema for xslt transformation

Creating Html templatesWhat is an HTML template?

Creating PDF templateWhat is a PDF template?