Keywords: Confluence | Inline Code | Formatting
Abstract: This article provides an in-depth exploration of various methods for formatting inline code in Confluence, focusing on the basic syntax of double curly braces and supplementing with advanced techniques such as preformatted styles and span macros. Based on official documentation and community practices, it offers a complete operational guide and considerations to help users efficiently display inline code snippets in different scenarios.
Introduction
In modern technical documentation, formatting inline code is crucial for enhancing readability. Confluence, as a widely used collaboration platform, offers multiple approaches to achieve this. This article systematically introduces methods for formatting inline code, drawing on official best practices and community experiences, to assist users in flexibly applying these techniques across different versions and configurations.
Basic Method: Double Curly Braces Syntax
The most straightforward way to format inline code in Confluence is by using the double curly braces syntax. Specifically, enclose the text to be formatted between {{ and }}, for example, typing {{example}} will render it in a monospace font, highlighting it as code. This method is simple and effective for most scenarios, such as marking class names, variables, or short code snippets.
It is important to note that the double curly braces syntax is stably supported in Confluence 4.x and later versions, but users should ensure that editor settings are not overridden by custom configurations. In practice, this method does not disrupt paragraph structure, maintaining text fluidity.
Advanced Technique: Preformatted Style Option
For users of Confluence 4.x or higher, the preformatted style option from the paragraph style menu is another viable method. To use it, place the cursor on the target line, select the "Preformatted" option from the style dropdown in the toolbar, which converts the entire line to monospace font. However, this applies to the whole line rather than specific segments, making it suitable for line-level code display rather than precise inline control.
For instance, when describing a function call where the entire line consists of code, using the preformatted style can quickly achieve uniform formatting. But for embedding code within regular text, the double curly braces syntax is more appropriate.
Supplementary Method: Custom Styling with Span Macro
When basic methods fall short, such as for custom colors, borders, or backgrounds, users can leverage the Span macro. The steps involve highlighting the target text, searching for "span" in the macro search box and selecting it, then adding CSS code in the "inline style" section. For example, inputting border-radius: 5px; color: maroon; border: solid wheat 1px; background-color: whitesmoke; can achieve rounded borders and specific color highlighting for code.
This method is particularly useful for users without administrator privileges who cannot edit global CSS stylesheets. However, note that when using the Span macro within bulleted lists, it may force the content onto its own line, similar to a code block, so compatibility should be tested in context.
Practical Recommendations and Considerations
In practical applications, it is advisable to prioritize the double curly braces syntax due to its high compatibility and ease of use. For complex styling needs, the Span macro offers flexibility but may increase maintenance overhead. Users should avoid including unescaped HTML characters in code, for example, in print("<T>"), the < and > must be escaped to prevent parsing errors.
Additionally, version differences in Confluence may affect feature availability, so referring to official documentation for the latest information is recommended. By combining these methods, users can efficiently create professional technical documentation, enhancing team collaboration efficiency.