Using Image Captions

Since the HTML standard does not have a “caption” attribute for the img element, Flare doesn’t either. There is a caption sub element, but it only works nested inside of a table.

We can still use image captions, of course, they are just a little more work. Your image captions will simply be a paragraph with a particular style applied. We then wrap both that paragraph and the paragraph containing the image in a div that prevents the two from separating as they break across pages in print outputs.

Caption Numbering

The p.Figure style that you will apply to your caption paragraph will autonumber with the chapter and image count. In the XML Editor, all of these look like they are in Chapter 1 of an output, but this is just placeholder information. At build time these images will be dynamically numbered in sequence.

Manually Captioning an Image

  1. Place your cursor at the end of the paragraph containing the image you want to caption and press Enter to get a new paragraph.
  2. Type the content of the caption.
    • This content should be descriptive of the image but does not have to start with “This image”, just go straight to the point.
    • Sentence fragments are acceptable in captions as they are essentially labels.
  3. Click to select the caption paragraph.
  4. Click the Style dropdown selector in the Home Ribbon and choose the p.Figure style. The Figure X.Y prefix should apply to the paragraph.
  5. Select both the image and caption paragraphs and click the Group icon in the Home Ribbon.
    groupicon.png
  6. Select div.printunit from the Create group window.
    createprintunit.png
    You will see both paragraphs now nested inside the div.caption1.png

Do I need to Caption Every Image?

In short, no. If it is clear from the context why the image is there and you do not need to cross reference it from another location, you can likely skip captioning. Images in steps do not generally need captions. However, note that longer form documents have a list of images in the appendix and only captioned images will be added to that list.

Use Starter Elements

The smaller version of reusable content in Flare, snippets, have a second usage. Normally, you insert snippets and do not make changes to them. However, you can also use them as mini templates for objects that you use over and over. We have created some special snippets for just this use case.

This starter element will place an image into your topic already followed by a p.Figure paragraph and wrapped in a div.printunit div.

  1. Place the cursor in the empty paragraph where you want to create the caption image. Do this before entering any of the content that goes into the note.
  2. Click the Snippet dropdown selector in the XML Editor and select More Snippets from the dropdown selector.
    selectsnippet1.png
  3. Select the Empty_Image_wCaption snippet.
    SelectEmptyImageSnip.png
  4. Click OK.
  5. Right click the snippet you just inserted and select Convert to Text from the context menu.
    caption2.png
  6. Right click the placeholder image and select Image Properties.
  7. Browse to and select your image, then click OK to replace the placeholder.
  8. Click into the caption paragraph and replace the placeholder text with your caption. The prefix will apply after you add content.

 

Advertisements

Conditions Tags

Conditions are what give our single sourced content its flexibility. Conditions are a way of tagging content with metadata that you can use to include or exclude content when you build your target. For instance, we have a set of conditions for Audience. If a topic is the same for both customers and internal employees except for one paragraph, you can write two versions of that paragraph in the topic and have the target include/exclude each as appropriate when you are building your outputs.

All conditions you are likely to need are created for you already.

There are two major actions to using conditions, tagging the content and setting the filters.

Tagging Content with Conditions

  1. Open the topic in which you need to apply condition tags if it is not already open.
  2. Click the structure bar for the content you would like to tag.Conditions1.png
  3. Right click the element and select Conditions from the dropdown selector.Conditions2.png
  4. On the left pane, select the Set that contains the tag you want to add.
  5. On the right pane, locate and toggle ON the condition(s) you want to add.conditions3
  6. Continue toggling on all conditions that should apply to this content. This almost always also includes the Hide condition found in the Functional set. Content with the Hide tag is hidden by default unless explicitly included.Conditions4.png
  7. Click OK to save. The structure bar for the tagged element will now show colors that indicate it has tags on.Conditions5.png

    You can hover your mouse over any tagged element to see what tags are applied to it.

    Conditions6.png

Setting Filters on Targets

For each target we use, we set filters that specify what tagged content should be included or excluded.

  • Untagged content is always included.
  • If an element has both included and excluded tags, include always wins.
  • Always set the Functional.Hide tag to exclude in your targets.

Setting up targets is generally something that the Technical Editor will assist you with. However, if you do have to set filters:

  1. Open the Target in which you want to set filters. Targets are found in the Project Organizer.
  2. Select the Conditional Text tab on the left side of the Target window.
  3. Toggle only the tags you are concerned with to Include or Exclude as needed. you do not need to visit every possible option in every target.Conditions7.png

    Similar Interfaces

    You will notice that the interface for tagging content and for setting filters is largely the same. Remember that if you have include and exclude options, you are setting filters. If you only have a single toggle, you are assigning those tags to something.

  4. Save your changes.
  5. Build a test output to see if your tags are assigned correctly, or use the preview in the XML Editor.

 

Putting Links into Knowledge Articles

In a knowledge article, you can link to other articles or any other location on the internet or intranet. There are two methods for inserting links, one for articles and a second for everything else.

Links Are Not Functional while Editing Articles

While in editing mode for a particular article, clicking the hyperlinks in your content will not take you to the link location. To test your links, you must save your changes and click the Preview icon to open the article preview tab. The links will function in the preview window.

Inserting Hyperlinks to Other Articles (Smart Links)

SFDC calls the link to articles feature Smart Links. These are still hyperlinks, but SFDC formats them in a special way that makes sense to itself and then inserts the target article title as the display text.

  1. Place your cursor exactly where you want the link to go.insert hyperlink7
  2. Click the Smart Link icon in the toolbar for the current field. The Link Article window will open.
    Insert hyperlink2.png
  3. Enter an article number or other search text into the search field and press Enter.Insert hyperlink3.png
  4. Click to select the target article and click OK to insert the link. The link should appear where your cursor was, complete with the article title as the display name.insert hyperlink4.png

Inserting Hyperlinks to other Locations

For all other locations that are not other articles, use the Insert Link icon.

  1. Type all of the display text out where you wan the link to go.insert hyperlink5.png
  2. Select the specific text in which you want to embed the hyperlink.insert hyperlink6.png
  3. Click the Insert Link icon. The Link window will open.insert hyperlink7.png
  4. Type or paste into the URL field the complete URL of the target file.insert hyperlink8.png
  5. Click OK to save your changes. You will be returned to the editing window with your link in place.
    insert hyperlink9.png

Knowledge Centered Support Overview

Creating articles helps others who may encounter the same problem. Through recording, revision, and reuse of knowledge, we can solve issues more effectively.

In every opportunity for creating or revising articles, consider:

  • Are there new tools that would improve the article’s effectiveness?
  • Have there been product improvements or changes that may affect the content of the article?
  • Can FictionSoft be used to simplify or increase the accuracy of the diagnosis or solution?

Key Actions

If an article for the issue doesn’t exist, create it

Press Save and Create Article from the close case form to copy over all applicable case fields to your new article.

Goal: Collaboration and sharing of everyone’s knowledge.

If an article for the issue does exist, improve and reuse it

When you read an article, you might find that there are additional details, symptoms, or problems that lead to the same article. Add them to the article and submit it for publishing.

Goal: Increase confidence in an article by improving and reusing it.

If an article applies to your case, attach it and rate it

If an article helps you solve a case, attaching to the case and rating it will help others know that the article was useful and reusable.

Goal: Reusing and rating articles will highlight articles that are fixing problems.

Don’t re-solve old problems.

Warp Drive Hardware and Software Improvements Increase Warp Field Stability

Starfleet Engineering has made several improvements to the Class 7 warp engines deployed to Defiant class starships, resolving software issues that could cause warp field collapse. While the improvements are intended to resolve issues specific to Defiant Class starships, some affected parts are common to all starships fitted with Class 7 or later warp engines.

As of this communique, all listed fixes are currently deployed in newly manufactured warp engines and all spare parts are being fulfilled with their latest revision.

Root Causes and Counter Measures

Table 1
Root Cause Counter Measures Developed
The ship’s software can misinterpret feedback from the condenser coils and create false reactor faults
Updated software uses a more sophisticated method of determining true reactor faults.
  • Software v1.0.484 (Defiant)
  • Software vR08SP3 (Intrepid)
Electrical discharge within the condenser coils itself can produce reactor faults.
The condenser coils are redesigned to eliminate the internal arcing.
  • Condenser Coil Rev AE
  • Cut-in as of Star Date 48212.4.
Vibration from the input manifold can cause other internal components to degrade over time. The input manifold bracket is redesigned to provide better vibration absorption and isolation. 

  • Cut in as of Star Date 48212.4.
Several physical aspects of the warp core assembly required improvement to provide better warp field robustness. The warp core is redesigned to increase overall uptime and robustness. 

  • Cut-in as of Star Date 48218.2.

Condenser Coil Improvement

The Condensor Coil and Charge Electrode in the Class 7 warp engine are enhanced with a rounded design. This decreases the chance of reactor faults and increases overall uptime performance.

https://upload.wikimedia.org/wikipedia/commons/thumb/7/7e/Sphere_wireframe_10deg_6r.svg/240px-Sphere_wireframe_10deg_6r.svg.png https://upload.wikimedia.org/wikipedia/commons/thumb/7/74/Oval-definition-en.svg/225px-Oval-definition-en.svg.png
Figure 1: Updated Condenser Coil Figure 2: Updated Charge Electrode

Part numbers for warp drive components have not changed. Order the same part numbers as previously used to receive the upgraded spares.

Table 2: Warp Engine Parts Affected
Part# Description
123546 Class 7 Warp Core
234567 Class 7 Warp Core with Cheese
345678 Class 7 Warp Core, Green Edition
456789 Class 7 Warp Core, Biodiesel Edition
567891 Class 7 Warp Core with LaForgeness

Minimum Software Versions

Fixes to address the War Core Robustness are included in the following currently available general software releases:

v484 Software Release for Defiant Class Starships

Relevant software change:

  • DEFMOL-3833: Reactor Fault threshold is calculated by averaging method
    You will no longer need to calibrate the reactor and the calibration option is removed from the menu. Note that Class 6 and older engines all still use the old method and will still require calibration at this time.

Software Update 404755.CU.r08SP3 for Intrepid Class Starships

Relevant software change:

  • Reactor Fault Threshold Improvements
    You will no longer need to calibrate the reactor and the calibration option is removed from the menu.

Input Manifold

The Input Manifold included in the Spare Input Manifold Kit (PN SP2315468) and Double Headed Input Manifold Kit (PN 2154785) now includes resilient mounting in the form of rubber grommets that reduce the magnitude of vibration by a factor of 3 – 4 times. The Input Manifold Bracket is available now as a stand alone spare part under PN SP54125478 for upgrading existing installations.

image source: https://commons.wikimedia.org/wiki/User:Sam_Sailor

Figure 3: Updated Input Manifold Bracket with grommets.

Condenser Coils

It was determined that Condenser Coil reliability is sometimes compromised by internal arcing, which leads to reactor faults. Revision AE improves the internal construction by means of better high voltage slotting, improved conformal coating, and tighter design specifications to limit inadvertent changes in design.

Follow Best Practices

These improvements are upgrades, are not mandatory, and are not warrantied replacements. You should still complete your normal troubleshooting steps before replacing any parts.