How to use macros to organize documents “like in Confluence”? / Hebrew

How to use macros to organize documents “like in Confluence”? / Hebrew

Greeting! After all, it’s nice to read well-designed articles on a cozy couch, isn’t it? In which part of the text is hidden under the cat, there are captions to the pictures, beautiful and clear tables and the rest of all the goodies? I think very nice. Therefore, I suggest you consider some useful tips about which macros in Confluence helped to do this before, and now definitely also help in EvaWiki.

There is a lot of useful information on the Internet about using Confluence. For example, here is an article with recommendations for using macros. It describes everything quite coolly, but I would like to make an amendment. Confluence left Russia, and EvaWiki stayed. And now the functionality that was in the foreign solution can be used in Russian.

The article may be useful for those who have actively worked in Confluence and want to do exactly this in our software.

Allow me a historical reference for half a minute (c)

In 2022, Atlassian left the Russian market. Russian business had been using its products for years, so the withdrawal from the market was dramatic. For some time it was possible to work under the old licenses, but it was not clear what to do next? For the EvaTeam, everything was obvious – it was necessary to develop its products, similar to what Atlassian had.

We assumed that when switching to a new product, not a single bit of data would be lost, and the analog product itself would be such that switching to it would be simple and fast. That’s what EvaWiki is: it’s a Confluence analog with a seamless transition: you just copy the data, exit Confluence, upload the data to EvaWiki, and go.

And if you used any settings or macros in Confluence, you can easily find them in EvaWiki. I will prove this below.

Macros: Why you need them and how they work in Confluence

Macros significantly expand the possibilities of working with texts and documents – they help to configure navigation in the knowledge system, create a unified approach to the design of certain types of documents. Macros provide loading of content from the outside or setting of “beauty” such as bright inserts, colored quotes, etc.

Like Confluence, EvaWiki has keyboard shortcuts familiar to most users, as well as typical navigation, starting from the toolbar and shortcuts, and ending with the MagicKey (slash border). Visually, working with documents looks simple and intuitive.

Working through the magic key, with the help of a slash, you can call up an additional menu and “turn on” the desired content in the desired form at any point/line of the document. Everything is specially made for familiar Confluence users. Seeing the usual ways of addressing macros, they calm down and after 10 minutes they are working in EvaWiki as if they have always been there.

Atlassian products have dozens of built-in macros and even more than a thousand third-party ones. But usually even very advanced users need about 20-30. And if we talk about the most popular and the most popular, then there will be a maximum of a dozen of them. But they should be the clearest, simplest and most convenient.

Content

The most popular arrangement of data is the macro for automatic content generation. There is no need to “crawl” through the entire document, but you can immediately turn to the desired block.

Links are formed by headings and immediately become active.

Layouts

The second macro on request is “Layouts”, which is necessary for everyone who wants to design a document correctly and beautifully. At a minimum, break it into blocks or columns to systematize the content and simplify its perception.

Info panels and quotes

As in Confluence, we have the “Infopanel” macro – with its help, you can highlight and visually select the necessary sections of the text. True, in EvaWiki, the set of such inserts is larger than in the basic version of Confluence – 6, not 4: so that, as they say, “color differentiation of pants” (that is, important fragments of content) is for every taste.

For example, enter /note, /information, / ready, /importantly, /error or /warning – And add the element you need.

Emphasize the quote by adding a vertical border to its left margin and adjusting the font color. Enter /quoteto quickly add it to your content.

Tables

Without false modesty, I will say that the functionality of working with tables in EvaWiki is such that you will not find in most similar products. With the help of not only macros, but various settings here, you can play with the tables in any way you want! Add, remove columns or rows, automatically form headers, call and configure additional options in one click (using the plus signs), etc. You can group cells, set colors, set standard alignment, and more – such a breadth of functionality is available, probably, only here and in Excel.

Attachment

I put the “Attachments” macro on the 5th place in terms of popularity – it allows you to display all attachments that have ever been added to a document. They can be displayed on the page for viewing or downloaded as one archive. Also, using the document attachments functionality, you can refer to these attachments when adding other macros, without having to download them again. Very comfortable.

Include (Sample)

The next macro is called “Inserts” or “Includes” – it allows you to literally assemble a new document, like a puzzle, from the right pieces of other documents. This is an extremely important thing for companies with extensive or complex document flow, when some key documents are often cited to others.

We create a sample in Document 1

Select and paste in Document 2

This functionality helps not only to easily “copy and paste” important information (it would be too easy), but also to easily make changes to a huge array of papers! So, if some part of the content changes in the “parent” document, then this content will also be automatically updated in all the infinitely huge number of “child” documents.

“Kath” (Expand)

But what about the beloved “hanger”, which allows you to hide huge rolls of text going down, someone will ask? There is also such a macro, “Expand” – settings for collapsing/expanding content. There is nothing to say about how convenient it is.

Insert Word/Excel

EvaWiki allows you not only to work with content, but also to “upload” any Word or Excel document to the desired page. The super feature of the Office Word/Excel macro is that it is not loaded in import mode, but directly inserted into the file with all parameters and original formatting. And you can change something in this file as you like, and versioning of attachments will ensure automatic updating of all documents where the file is.

Status

Lovers of bright visual accents will like the “Status” macro, with the help of which you can “press” an important quote in a colored cut-out or bubble cloud into the document. It is not just beautiful, but also important for highlighting some important meanings or nuances in large, serious texts.

Display tree of pages and children

There are two very convenient and functionally similar macros – “Display page tree” and “Display children”. The first one allows us to indicate from which document in circulation on a certain topic we will get the structure, and to set the depth of the hierarchy to it. The structure of interrelationships will be built directly in the document – similar to the content, but only according to the sources or structures of the documents.

The second macro works according to the same principle, only it builds “branches” of child documents from the current one (the one in which we are working). You can at any moment see, roughly speaking, what grows from what!

Communication register

And here’s what the basic Confluence didn’t have (at least for 2022) – the “Communication Registry” macro. This powerful tool allows you to compile reference lists to see which documents link to what. Why is this necessary?

In large, branched structures or companies with a long history, it is sometimes difficult to understand the system of bureaucratic communication. Build this relationship between documents, understand which doc refers to which doc, and this macro allows. In addition, the type of connection (outgoing or incoming) is indicated for each file, which will help partially establish the history and hierarchy of various documents. At the same time, the register can be built not only by documents, but also by tasks with which connections are established.

https://docs.evateam.ru/files/obj/CmfDocument/CmfDocument%3A73c/CmfDocument%3A73c35608-5ed0-11ee-b663-00161e12fc1e/ezgif-1-865bb8c240.gif

Sometimes it is very important. For example, it seems to you that no one reads some old protocol/order/guide and does not make sense. You can check its communication register and suddenly find out that some more relevant documents do not work without this file. And sometimes you can find documents that are not related to any other files — and decide accordingly how much they are needed by the company.

Plugins

Separately, it is worth saying that EvaWiki implements not only standard Confluence macros, but also popular plugins. And if in the old solution they need to be purchased separately on the marketplace, then here their functionality already works “out of the box”. These are, for example, draw.io, PlantUML, Comala Document Management and others plugins.

This is not the entire list of implemented macros, but only the most popular ones that used to be used in Confluence and can now also be used in EvaWiki.

Tell us, which macros are your “favorites” or which ones do you use more often than others? Maybe (but unlikely))) these are macros from some other systems that you missed before and in Confluence?

Related posts