Posts Tagged ‘Tools’

Coloring code in Flare with Prettify

Posted in Madcap Flare, Tools on February 15th, 2012 by Jenny – 11 Comments

Recently I worked on some API documentation with dozens of examples of code snippets. Anyone who reads code will tell you that color coding (syntax highlighting) makes code much easier to read.

Since I was writing the API documentation in Madcap Flare, I needed a tool that I could use in that environment. Initially I tried the Syntax Highlighter, but I couldn’t get it to work for me. So I did another search, and discovered Prettify, a syntax highlighter by Google, and that worked like a charm.

To use Prettify with Madcap Flare:

  1. Download the Prettify tar file and unzip it (I used Winzip).
  2. Copy the files from the distrib/google-code-prettify folder.

  1. In your Flare project, paste the files into the Resources folder (I created a Prettify subfolder under Resources).

  1. In Flare, open the topic containing the code snippet in the Internal Text Editor.
  2. In the <head> element, add links to the javascript file and the css stylesheet (A)
  3. In the <body> tag, add the onload instruction (B).
  4. Add <pre> tags around your code snippet, specifying the prettyprint class (C).

Here’s what the Javascript code snippet looks like in Webhelp and HTML Help output:

NOTE: This doesn’t work for PDF output.

Update September 12, 2012: Check out the MadBlog for instructions on how to use Prettify across all the topics in your project.

 

If you liked this post, consider subscribing to my RSS feed. Or have posts delivered via email. Thanks for visiting!

 

Share

Making PDFs in Confluence

Posted in Confluence and JIRA on December 12th, 2011 by Jenny – 3 Comments

New Zealand PohutukawaIn the mailbag this week, a reader asked if there’s a way to convert a Confluence wiki into a PDF. When we get our Confluence wiki off the ground, this will be an absolute necessity for our team too since we have some customers who are not online 24/7.

I’ve found two ways to make a PDF:

1. Make a PDF of a single Confluence page

  1. In Confluence, find the page that you want to turn into a PDF.
  2. Click Tools, then select Export to PDF.
  3. Save the PDF somewhere you’ll be able to find it.

2. Make a PDF of a Confluence space or selected pages

  1. In Confluence, find the space you want to save as a PDF.
  2. Click Browse, then select Advanced.
  3. Click PDF Export.
  4. Click Select All to save the whole site as a PDF, or select the pages you want to save as a PDF. Note: There is also a link on this page for the PDF Stylesheet if you want to change the appearance of the PDF.
  5. Click Export.
  6. When the export is complete, click the link for Download here.
  7. Save the PDF somewhere you’ll be able to find it.

That’s it. Pretty straightforward!

Resources:
Exporting Confluence Pages and Spaces to PDF
Customising the Appearance of PDF Exports

 

If you liked this post, consider subscribing to my RSS feed. Or have posts delivered via email. Thanks for visiting!

Photo via Flickr user Abaconda

Share

Blogging with Confluence

Posted in Confluence and JIRA, Tools on June 23rd, 2011 by Jenny – 3 Comments

Cape Reinga, New ZealandA new requirement for our customer portal is to add blogging.

Our marketing team have been using Typepad, so they want a platform that is just as easy to use. But we also need a tool that can integrate with our Umbraco/Confluence site and one that can use our existing security.

Someone else on the team is looking at Umbraco, but I thought I’d share what I learned about blogging in Confluence.

1. Blog posts can be published from any space

Blog posts can be created from any space in your Confluence site with the right permissions. You can allow individual users, or groups of users, permission to create posts, and you can give some users permission to comment, and others permission to just view posts.

In our case, to start with, we want a single user to post updates for all the divisions in our company. The easiest way to do this it seems, is to set up a separate space for the blog.

2. Adding a blog post

Adding a blog post is just as simple as you’d expect. Simply browse to the appropriate space, click Add, and then Blog Post. Give the post a title, type in your entry, and click Save, just like you would for a Confluence page.

3. Displaying blogposts

To display blog posts, use the Blog Posts macro. You can restrict the posts displayed by label, author, time frame, and space, and you can sort the order that the posts appear. You can also choose whether to show just the title, or the title and an excerpt.

4. Moderating comments

There is no built-in way to moderate comments in Confluence 3.5, but you can install a beta plug-in (Confluence Comment Moderation). I installed the plugin, and once I’d found the Comment Moderation settings in the Space Admin panel, it worked for me.

One thing I’m still searching for, is a method for automatically pushing Confluence blog posts to Twitter and Facebook. Has anyone found a way to do this?

Resources:

Working with blog posts

 

If you liked this post, consider subscribing to my RSS feed. Or have posts delivered via email. Thanks for visiting!

Photo via Flickr user Heike Quosdorf

Share