Quick Access Corner

Using a wiki can prove a bit difficult when you're not used to it. Learn how to best handle the wiki: understanding its structure, getting the most useful infos at hand, using the macros to easily add content with respect to the contributions rules.

Numerous ways to find the information you want are available.
You can discover all of them on your own, or take a quick glance on this browsing helper.

Using the header

As on most websites, the Petals Documentation logo brings back to the homepage.
The top-right bar is shared between all Petals community websites.
Use it for a quick jump between corporate website (infos on commercial support), community website (technical infos), forum (community support), downloads (to get Petals products), and documentation (this wiki).

Using the top navigation bar

This is the main navigation bar:

On the left part is the breadcrumb, to quickly access parent pages of the one currently viewed.
On the right part, from left to right:

the browse menu: allows to browse a whole space's content by type: pages (wiki content), labels (browse content by keyword), attachments (all images, docs and others in this space), advanced (to export part or all of space in html/pdf), space admin (administration panel for space administrators).
the user menu: if authenticated, this menu will be named after your full name, and give access to [useful features]. Otherwise, links to login or signup will be displayed.
search panel: use this panel to look for content throughout whole website. Results will be displayed on-the-fly. Clicking on the last option (Search for xxx) will bring you to a detailed search panel.

Using the navigation sidebar

On every page, a left-sidebar is available, and contains a hierarchical view of the current space. To hide it and view current content with full screen width, click on this icon in the navigation bar. To display again, click on the same place.

Why register?

Registering to our documentation website is free, quick, and brings you these nices features:

define your favourite spaces (website sections) and pages, you'll see them directly on home page once authenticated.
watch pages and people, and receives automatic email notifications when related content is updated!
comment pages and contribute to content (with regards to Contributors Guideline)
get a personal space (on request) fully writable and customizable, and set it as your landing point.
Wait no more, register now!

Using favourites pages and spaces

What is a favourite? It's either a page or space that you check with clicking on the star icon next to it. You can then view all of them in a centralized view.

Setting a page or space as favourite

For a Space
When you're on the default welcome page of the website, you'll see a list of spaces, each one having at the right end, a gray star icon. Click on this star to mark the space as favourite. Favourite spaces are identified by a yellow star.

For a Page
When viewing a page, use the right "Tools" menu, then select "Favourite". You can also check herein if a page is marked as a favourite or not.

Viewing favourites

For Spaces
On the standard homepage, once authenticated, you'll see a tabbed list of spaces. Click on "My" tab to see only the spaces you marked as favourite.

for Pages
You can see them on the standard landing page. You can also add them yo the Home of your Personal Space thanks to the {favpages} macros.

Watching pages and people

Time for lazyness! Atlassian people made a great job in writing their documentation, why would we reinvent the wheel?

Watching a Space
Watching a Page
Managing Spaces

To configure your email settings, go to the settings > email menu of your user profile and tick desired option(s).

Updating your user profile

All your

link-to: A user must be logged in to access the 'user profile'.

profile informations and settings

can be accessed from any pages, by clicking on your name on the right of top menubar.

A dropdown menu is also available when hovering the pointer on your name, providing quick access to:

update status: quick note on what you're doing, thinking... Expressing the thoughts of one moment and tell other people what you're working on.
recently viewed: the latest pages you viewed/modified.
profile: your personal informations.
network: the people you follow, and the ones following you.
status update: history of your status.
labels: see the content you marked with a "my:xxx" label.
watches: list of pages you're watching.
drafts: saves of content you have been editing without saving modifications.
settings: you can configure here your landing page (when you connect), your timezone and preferred language.

Rules of contribution

Please take special note that any contribution to the wiki is ruled by our Contributors Guideline. Please read them carefully (in short, you accept that all of your contributions on this documentation wiki are published under CC-by-nc-sa, and you authorize Petals Link (EBM Websourcing) to use any and all of it in commercial offers, without any royalties or compensation.

Space:	Petals CLI 2.1.1	Browse the "petalscli211" space You dont have permission to add pages to "{0}"
Space:	Petals CLI 2.1.2+	Browse the "petalscli212" space You dont have permission to add pages to "{0}"
Space:	Petals CLI 2.2.0	Browse the "petalscli220" space You dont have permission to add pages to "{0}"
Space:	Petals CLI 2.3.0+	Browse the "petalscli230" space You dont have permission to add pages to "{0}"
Space:	Petals CLI 3.0.0+	Browse the "petalscli300" space You dont have permission to add pages to "{0}"
Space:	Petals CLI 3.1.1+	Browse the "petalscli311" space You dont have permission to add pages to "{0}"
Space:	Petals CLI 3.2.0-SNAPSHOT	Browse the "petalsclisnapshot" space You dont have permission to add pages to "{0}"
Space:	Petals Cockpit SNAPSHOT	Browse the "petalscockpitsnapshot" space You dont have permission to add pages to "{0}"
Space:	Petals Components	Browse the "petalscomponents" space You dont have permission to add pages to "{0}"
Space:	Petals Documentation Homespace for the whole Petals products documentation.	Browse the "welcome" space You dont have permission to add pages to "{0}"
Space:	Petals ESB Introduction, user and developer guide for Petals ESB, the open source Enterprise Service Bus.	Browse the "petalsesb" space You dont have permission to add pages to "{0}"
Space:	Petals ESB 3.0 Introduction, user and developer guide for Petals ESB, the open source Enterprise Service Bus.	Browse the "petalsesb30" space You dont have permission to add pages to "{0}"
Space:	Petals ESB 3.1 Introduction, user and developer guide for Petals ESB, the open source Enterprise Service Bus.	Browse the "petalsesb31" space You dont have permission to add pages to "{0}"
Space:	Petals ESB 4.0 Introduction, user and developer guide for Petals ESB, the open source Enterprise Service Bus.	Browse the "petalsesb40" space You dont have permission to add pages to "{0}"
Space:	Petals ESB 4.1 Introduction, user and developer guide for Petals ESB, the open source Enterprise Service Bus.	Browse the "petalsesb41" space You dont have permission to add pages to "{0}"
Space:	Petals ESB 4.2 Introduction, user and developer guide for Petals ESB, the open source Enterprise Service Bus.	Browse the "petalsesb42" space You dont have permission to add pages to "{0}"
Space:	Petals ESB 5.0.0+ Introduction, user and developer guide for Petals ESB, the open source Enterprise Service Bus.	Browse the "petalsesb500" space You dont have permission to add pages to "{0}"
Space:	Petals ESB 5.0.2+ Introduction, user and developer guide for Petals ESB, the open source Enterprise Service Bus.	Browse the "petalsesb502" space You dont have permission to add pages to "{0}"
Space:	Petals ESB 5.1.0 Introduction, user and developer guide for Petals ESB, the open source Enterprise Service Bus.	Browse the "petalsesb510" space You dont have permission to add pages to "{0}"
Space:	Petals ESB 5.2.0 Introduction, user and developer guide for Petals ESB, the open source Enterprise Service Bus.	Browse the "petalsesb520" space You dont have permission to add pages to "{0}"
Space:	Petals ESB 5.3.0 Introduction, user and developer guide for Petals ESB, the open source Enterprise Service Bus.	Browse the "petalsesbsnapshot" space You dont have permission to add pages to "{0}"
Space:	Petals Master Introduction, user and developer guide for Petals Master, the open source SOA governance tool.	Browse the "petalsmaster" space You dont have permission to add pages to "{0}"
Space:	Petals Master 1.0 Introduction, user and developer guide for Petals Master, the open source SOA governance tool.	Browse the "petalsmaster10" space You dont have permission to add pages to "{0}"
Space:	Petals Master 1.1 Introduction, user and developer guide for Petals Master, the open source SOA governance tool.	Browse the "petalsmaster11" space You dont have permission to add pages to "{0}"
Space:	Petals Master Snapshot Introduction, user and developer guide for Petals Master, the open source SOA governance tool.	Browse the "petalsmastersnapshot" space You dont have permission to add pages to "{0}"
Space:	Petals Registry CLI 1.1.1+	Browse the "petalsregcli111" space You dont have permission to add pages to "{0}"
Space:	Petals Registry CLI 1.2.0	Browse the "petalsregcli120" space You dont have permission to add pages to "{0}"
Space:	Petals Registry CLI 1.3.0	Browse the "petalsregcli130" space You dont have permission to add pages to "{0}"
Space:	Petals SE Flowable 1.0.0+	Browse the "petalsseflowable100" space You dont have permission to add pages to "{0}"
Space:	Petals SE Flowable 1.1.0+	Browse the "petalsseflowable110" space You dont have permission to add pages to "{0}"
Space:	Petals SE Flowable 1.1.2+	Browse the "petalsseflowable112" space You dont have permission to add pages to "{0}"
Space:	Petals SE Flowable 1.2.0	Browse the "petalsseflowable120" space You dont have permission to add pages to "{0}"
Space:	Petals SE Flowable 1.2.1+	Browse the "petalsseflowable121" space You dont have permission to add pages to "{0}"
Space:	Petals SE Flowable 1.3.0	Browse the "petalsseflowable130" space You dont have permission to add pages to "{0}"
Space:	Petals SE Flowable 1.3.1+	Browse the "petalsseflowable131" space You dont have permission to add pages to "{0}"
Space:	Petals SE Flowable 1.4.0+	Browse the "petalsseflowable140" space You dont have permission to add pages to "{0}"
Space:	Petals Studio Documentation home for Petals Studio, the open source IDE of Petals ESB.	Browse the "petalsstudio" space You dont have permission to add pages to "{0}"
Space:	Petals Studio 1.0 User guide, tutorials and resources about Petals Studio 1.0.	Browse the "petalsstudio10" space You dont have permission to add pages to "{0}"
Space:	Petals Studio 1.1 User guide, tutorials and resources about the development version of Petals Studio.	Browse the "petalsstudio11" space You dont have permission to add pages to "{0}"
Space:	Petals Studio 1.2 User guide, tutorials and resources about the development version of Petals Studio.	Browse the "petalsstudio12" space You dont have permission to add pages to "{0}"
Space:	Petals Studio 1.3 User guide, tutorials and resources about the development version of Petals Studio.	Browse the "petalsstudio13" space You dont have permission to add pages to "{0}"
Space:	Petals Studio 1.4 User guide, tutorials and resources about the development version of Petals Studio.	Browse the "petalsstudio14" space You dont have permission to add pages to "{0}"
Space:	Petals Studio Snapshot User guide, tutorials and resources about the development version of Petals Studio.	Browse the "petalsstudiosnapshot" space You dont have permission to add pages to "{0}"
Space:	Petals View Introduction, user guide and tutorial for Petals View, the open source business monitoring tool.	Browse the "petalsview" space You dont have permission to add pages to "{0}"
Space:	Petals View 1.2 Introduction, user guide and tutorial for Petals View, the open source business monitoring tool.	Browse the "petalsview12" space You dont have permission to add pages to "{0}"
Space:	Petals View Snapshot Introduction, user guide and tutorial for Petals View, the open source business monitoring tool.	Browse the "petalsviewsnapshot" space You dont have permission to add pages to "{0}"
Space:	Petals Webconsole Introduction, user and developer guide for the Web Console, the technical monitoring tool for Petals ESB.	Browse the "petalswebconsole" space You dont have permission to add pages to "{0}"
Space:	Petals Webconsole 2.0 Introduction, user and developer guide for the Web Console, the technical monitoring tool for Petals ESB.	Browse the "petalswebconsole20" space You dont have permission to add pages to "{0}"
Space:	Petals Webconsole Snapshot Introduction, user and developer guide for the Web Console, the technical monitoring tool for Petals ESB.	Browse the "petalswebconsolesnapshot" space You dont have permission to add pages to "{0}"
Space:	testjs	Browse the "testjs" space You dont have permission to add pages to "{0}"

Test mise en page

Quick Access Corner

Recently Updated

Using the header

Using the top navigation bar

Using the navigation sidebar

Why register?

Using favourites pages and spaces

Setting a page or space as favourite

Viewing favourites

Watching pages and people

Updating your user profile

Rules of contribution

Creating pages

How to create pages

Best practices

Editing pages

How to edit pages

Best practices

Using macros

Labels