You are previewing Atlassian Confluence 5 Essentials.
O'Reilly logo
Atlassian Confluence 5 Essentials

Book Description

Centralize all your organization’s documentation in one place using Confluence. From installation to using add-ons, this is a complete, user-friendly tutorial that assumes virtually no prior knowledge.

  • Create and manage project documentation with Confluence

  • Share and collaborate on documentation between departments and teams

  • Install, configure, manage, and extend Confluence

  • In Detail

    Every idea, concept, and project needs documentation, which is traditionally kept in a variety of documents on different devices. Confluence 5 centralizes that documentation and provides it in one single location, available from almost any device and location.

    Atlassian Confluence 5 Essentials is a practical, hands-on guide explaining not only how to install and administrate Confluence, but also everything you need to create, share, and collaborate on your documentation. This book will give you everything you need to get started with Confluence.

    Before you can start creating content, Confluence needs to be available. That is exactly where we start with this book; installing Confluence. Through a number of clear, practical exercises you will go from installation and administration, to creating content and involving your teammates.

    This book will teach you how to quickly create compelling content. You will learn how to involve your teammates in the process, using the Confluence workbox and share features. You will learn how Confluence can be customized with regards to look and feel, extra functionality, and integration with other tools, so that there is nothing in your way when you want to introduce Confluence 5 within your organisation.

    If you need to develop better collaboration on mission critical projects, then this book is for you!

    Downloading the example code for this book. You can download the example code files for all Packt books you have purchased from your account at http://www.PacktPub.com. If you purchased this book elsewhere, you can visit http://www.PacktPub.com/support and register to have the files e-mailed directly to you.

    Table of Contents

    1. Table of Contents
    2. Atlassian Confluence 5 Essentials
    3. Credits
    4. About the Author
    5. About the Reviewers
    6. www.PacktPub.com
      1. Support files, eBooks, discount offers and more
      2. Why Subscribe?
      3. Free Access for Packt account holders
      4. Instant Updates on New Packt Books
    7. Preface
      1. What this book covers
      2. What you need for this book
      3. Who this book is for
      4. Conventions
      5. Reader feedback
      6. Customer support
        1. Downloading the example code
        2. Errata
        3. Piracy
        4. Questions
    8. 1. Getting Started with Confluence
      1. Understanding the architecture
        1. High-level architecture
        2. Supported browsers
        3. Data storage
        4. Confluence Installation directory
        5. Confluence Home directory
      2. Installation options
        1. Standalone and WAR distributions
        2. Operating systems
        3. Databases
        4. Application servers
      3. Installing Confluence
        1. Installing Java
        2. Installing PostgreSQL
          1. Creating a user and a database
        3. Installing Confluence
          1. Unpacking Confluence
          2. Configuring Confluence Home
          3. Configuring the port
          4. Configuring e-mail JNDI resource
          5. Configuring HTTPS
            1. Generating a certificate
            2. Configuring Tomcat
            3. Redirecting traffic to HTTPS
          6. Configuring Confluence as a service
      4. Starting Confluence
        1. Installation wizard
        2. Setting up the e-mail server
      5. Summary
    9. 2. User Management
      1. Understanding authentication
        1. Password authentication
        2. Seraph
      2. Adding users
        1. Manually adding users
        2. Open registration
        3. Inviting users
      3. Managing groups
        1. Creating groups
        2. Adding users to groups
          1. Editing group membership from the user details screen
          2. Editing group membership via the group management screen
      4. Administrating users
        1. Searching for users
          1. Using the simple user search
          2. Using the membership search
        2. Editing user details
        3. Resetting the password
      5. Public signup
      6. External user directories
        1. The effect of directory order
        2. Limitations when using external directories
          1. Build-in user management
          2. Editing directories
        3. Connecting to an LDAP directory
          1. Connecting to LDAP
          2. Server settings
          3. LDAP schema settings
          4. LDAP permissions
          5. Advanced settings
          6. User schema settings
          7. Group schema settings
          8. Membership schema settings
        4. Connecting to a Crowd directory
          1. Connecting to Crowd
          2. Server settings
          3. Crowd permissions
          4. Advanced settings
        5. Connecting to JIRA for user management
          1. Connecting to JIRA
          2. Server settings
          3. JIRA server permissions
          4. Advanced settings
      7. Summary
    10. 3. Creating Content
      1. The basic concepts
        1. Spaces
        2. Pages
        3. Blog posts
        4. Comments
      2. Adding global spaces
      3. Adding pages
        1. Adding a new page to Confluence
        2. Creating a page from another page
        3. Setting the location of a page
      4. The Confluence editor
        1. The toolbar
        2. Formatting and autocomplete
          1. Autoformatting
          2. Autocomplete
          3. Autoconverting
        3. Drag-and-drop
      5. Adding content
        1. Styling
        2. Macros
          1. The macro browser
          2. Editing macros
          3. Macro keyboard shortcut
        3. Panels
        4. Page layouts and sections
          1. Using page layouts
          2. Using Section and Column macros
        5. Tables
          1. Editing a table
          2. Keyboard shortcuts
          3. Sorting the table
        6. Attachments
          1. Attaching files to a page
          2. Attachment version management
          3. Downloading attachments
          4. Embedding attachments
            1. Multimedia
            2. Office files and PDF
            3. Drag-and-drop
        7. Images
          1. Displaying an attached image
          2. Displaying an attached image on a different page
          3. Displaying an image from a remote web page
          4. Changing the image's appearance
            1. Aligning your image
          5. Displaying images in a gallery
        8. Links
          1. Linking to Confluence pages
            1. Using Autocomplete
            2. Using the Insert Link dialog
            3. Using copy and paste
          2. Linking to web pages
          3. Linking to an anchor
          4. Linking to a heading
          5. Linking to an undefined page
        9. Drafts
          1. Changing the draft interval
          2. Resuming editing a draft
          3. Viewing unsaved changes
      6. Working with content history
        1. Viewing the page history
      7. Importing content
        1. Importing a Word document
          1. Importing a Word document as a single page
          2. Importing a Word document into multiple pages
      8. Exporting content
        1. Exporting a single page
        2. Exporting a space
      9. Summary
    11. 4. Managing Content
      1. Organizing your spaces
        1. Changing the order of pages
          1. Setting the page order to alphabetical
        2. Orphaned pages
        3. Archiving a space
      2. Using Confluence labels
        1. Content labels
        2. Attachment labels
        3. Using space categories
        4. Viewing labels
        5. Using labels to display content
          1. The Content by Label macro
      3. Tracking content
        1. Watching content
          1. Setting notification options
          2. Watching a page or a blog post
          3. Watching a space
          4. Managing your watches
        2. Favorites
          1. Adding favorites
          2. Viewing favorites
      4. Searching Confluence
        1. Quick navigation aid
        2. Full and advanced search
          1. "Did you mean"
          2. Filtering results
          3. Searching labels
        3. The search syntax
      5. Summary
    12. 5. Collaborating in Confluence
      1. Collaborating with other people
        1. Mentions
        2. Share content
        3. Like
        4. Status updates
          1. Updating your status
          2. Managing status updates
        5. Displaying status updates
      2. Working with notifications
        1. Managing your notifications
        2. Included notifications
        3. Configuring workbox notifications
          1. Enabling workbox notifications
          2. Including notifications from JIRA
          3. Sending notifications to another Confluence server
      3. Working with tasks
        1. Working with personal tasks
        2. Working with tasklists
          1. Managing tasks on a page
      4. Confluence on your mobile device
        1. Viewing
        2. User profiles
        3. Searching
        4. Notifications and tasks
        5. Notes about the mobile interface
      5. Summary
    13. 6. Securing Your Content
      1. Accessing the content
        1. Global permissions
          1. Updating global permissions
          2. Overview of the global permissions
          3. Comparing the administration roles
          4. Notes on global permissions
        2. Space permissions
          1. Overview of the permissions
          2. Managing space permissions
          3. Setting default space permissions
        3. Page restrictions
          1. Page restriction hierarchy
            1. Inheritance
          2. Managing page restrictions
      2. Confluence security
        1. Secure administrator sessions
        2. Atlassian security advisory
        3. Limiting access to Confluence administration
        4. Best practices
      3. Summary
    14. 7. Customizing Confluence
      1. The Confluence dashboard
        1. The Confluence home page
        2. The welcome message
          1. Restoring the default welcome message
          2. Removing the Get Started text
          3. Including content from another page
      2. Themes
        1. The Default Theme
          1. Configuring the theme
        2. The Documentation Theme
          1. Configuring the theme
      3. Look and feel
        1. Confluence logo
        2. Space logo
        3. Color schemes
      4. Advanced customizing
        1. The default space content
        2. Custom HTML
        3. Custom stylesheets
        4. Site layouts
      5. Summary
    15. 8. Advanced Confluence
      1. Templates
        1. Using templates
        2. Creating templates
          1. Space templates
          2. Global templates
          3. Adding content to your template
        3. Importing templates
          1. Checking installed template bundles
          2. Making templates available for usage
      2. User Macros
        1. Managing user macros
        2. Writing user macros
        3. Writing a user macro template
          1. A descriptive header
          2. Parameters
          3. Template code
            1. Including another macro
      3. The Page Properties macro
      4. Shortcut links
        1. Creating a shortcut link
        2. Using shortcut links
      5. Summary
    16. 9. General Administration
      1. Working with add-ons
        1. The Marketplace
        2. The Universal Plugin Manager
          1. Online and offline modes
            1. Information transmitted by the UPM
            2. Switching to offline mode
          2. Finding new add-ons
          3. Installing add-ons
            1. Installing directly via the Marketplace
            2. Installing by file upload
          4. Updating add-ons
          5. Removing installed add-ons
          6. User requests for add-ons
            1. Viewing user requests
            2. Disabling user requests
      2. Content indexing
        1. Rebuilding the indexes
        2. Changing the indexing language
      3. Application links
        1. Adding an application link
        2. Editing an application link
        3. Space project links
        4. Configuring authentication
          1. Trusted applications authentication
          2. OAuth authentication
          3. Basic HTTP authentication
      4. Using Application Navigator
        1. Adding a new link
        2. Managing links
      5. Getting support
        1. Atlassian Answers
        2. Atlassian Support
          1. Atlassian Support tools
          2. Raising a support ticket
            1. Submitting a support request via Confluence
        3. Atlassian experts
      6. Summary
    17. 10. Extending Confluence
      1. The Atlassian Plugin SDK
        1. Installing the Atlassian Plugin SDK
          1. Prerequisites
          2. Setting up the Atlassian SDK
        2. Commands
          1. Creating a new plugin
          2. Adding a new module to your plugin
          3. Running a plugin in an application
          4. Running a specific version of an application
          5. Using the Maven Command Line Interface (CLI) plugin
          6. Running a standalone application
          7. The help command
          8. Maven
            1. The pom.xml file
          9. The plugin descriptor
          10. Using a development environment
            1. Installing Eclipse on Windows
            2. Installing the Maven Eclipse plugin
            3. Configuring the Maven plugin
      2. Building your first plugin
        1. Creating the plugin project
        2. Updating the generated code
          1. Adding plugin metadata to the POM file
          2. Verifying your Confluence version
          3. Cleaning up the plugin skeleton
        3. Adding a new macro module
          1. Implementing the macro interface
          2. Implementing the getBodyType and getOutputType methods
          3. Implementing the execute method
        4. Building, installing, and running your plugin
        5. Adding resources
        6. Releasing your plugin
          1. Setting distributionManagement
            1. Releasing your plugin without revision control
      3. Plugin module types
        1. Generic module types
        2. Confluence-specific module types
        3. The plugin module types in detail
          1. XWork
            1. The module descriptor
            2. The action class
          2. Web Sections
            1. The module descriptor
          3. Web Items
            1. The module descriptor
      4. Online resources
      5. Summary
    18. Index