Back to Paligo Academy
As I've explained to you before, we don't do heading 1s, 2s and 3s like you would in Word or Frame Maker or some of the HATs. Right? We have a title inside the section, and Paligo automatically applies the irrelevant hierarchy depending where it is in the topic or where it is in the publication. What we wanna do now is to show you how to add subsections, which is really going to be, in other words, the next heading level in the hierarchy. So I'll just put some text in. I'll be honest. The reason why I had text, it doesn't really help, you know, to show you how to use sections in the other trainings we're doing. I'm just a technical writer for thirty years, and I just can't put another heading right after another heading. There has to be text in between. Those of you tech writers can understand where I'm coming from. Pains me. So that's why I do it this way. So that one level below. So if I wanna put another heading level, what I do is bring up my elements with the alt + enter, and I want to add another section. So if we have a title again inside a section, look the same as this, as the paragraph directly in the section. Now I've got a new section with a new title, and we'll give it a title. I've called it second level heading, and I can put in here whatever I want just like in a regular section, the beginning of a top root. So maybe I'll get rid of this text. I will put a bullet in. Point one and point two. Simple, again, it's together the structure para inside that first bullet of that whole bulleted list of this second section inside the whole topic or the whole section. Let's have a little quick look in the preview to see what it looks like. So preview and HTML5. So you can see in here, we have this level, the top level, and the second one, you can see by the font, they're different. I want to go into the HTML, so you can actually see. If you're not familiar with HTML, it doesn't matter so much. It's just really for... to just to point something out to you. So I'm going to inspect, and if you will look here, this is an h2. If I inspect on the next level, it's an h3. So Paligo, as I said, previously, it assigns the appropriate heading level to you according to where it is. I think, just for interest, you can see on the right hand side, a dynamic table of contents has been created because I have multiple sections inside this topic. When we get to the publishing recording and training and we talk about layouts, it's a simple option to turn on. It's in the top section of the HTML5 Layout editor. Very simple to do. Press a button, it'll always appear for you. So if we look at the second level heading, this this section that we made, and let me ask you a question. Is it standalone or is it reusable in another topic at the moment? What do you think? You're absolutely right. It's stand alone, and it's not reusable. But we can make it reusable very simply. We can click on the section, not on the title, on the section, and it has an option to convert to reusable component. This allows me essentially to make it into another topic, and it'll appear in the content manager on the left. I can choose the folder where I want to put it, so I'll leave it where it is. And do I want to reuse it in the same place? Or just remove it from the topic altogether. So I want to remove it. And I'll click okay. Watch what happens. So second level heading now appears on the left hand side in the content manager, and it's been reused here. It's essentially like going 'insert component', which we'll see during the reuse training. Well, I'll just... let's do that for you quickly. A a quick preview of how inserting components work, 'insert component'. And I'll just put in about this company in here, and that's how an inserted component looks like. So, essentially, that's what the second level heading has become. We've taken it from a stand alone section inside a topic to being reusable. So now it could be reused in multiple places. Something else that might be of interest? What happens if I wanna do a section inside a section? So let's create another section here. And we'll call it 'first of a nest'. And now I wanna put a section inside this section. Now, obviously, you wouldn't go too far because it makes a pretty poor user experience. I was asked even yesterday. You know, what's the limit? Can you put five nested sections in? I'm not aware of a limit, but I did say I don't think your customers and the reader's gonna like that so much. But, again, it could be legitimate use case. But if I wanna put a section inside of a section, which is a normal case, as long as you're not going too far, So go to the end of that section and just put another section in. Like that. As you can see, it's a section inside a section, inside a section. If I do a quick preview, we'll see what it looks like. As you can see on the right hand side, which is even maybe even more visible, you can see that nested has become an indent in here at a smaller font. So just so you can see those things and you can play with them yourselves. You would have seen by now a couple of ways to manage your hierarchies in Paligo. There's also more to it with chunking, etc., but we can put a hierarchy inside a topic itself, and we have a hierarchy inside a publication. When we go into the reuse training, we'll go into that in more detail and other types of hierarchies and even discuss, you know, which ones to use and where. Just wanted to make you aware of different ways of doing hierarchies. Please go ahead, try to follow what I've done in this recording, and make some subsections yourselves and see how they preview. Enjoy playing with headings. I'll let you into a little secret. I didn't know what admonitions were either. So if you don't, it's fine, but I'll explain now very simple: notes, tips, warning, cautions. They're admonitions, and you often use these in your content, especially instructional content. Let's see how to create these admonitions and how to insert them or create new ones inside your content as you're writing. And remember, watch and play, please. Before we go and create a new admonition, let's see what type of admonitions we have. So if I go to any folder and I go to create content, if you remember, these are admonitions down here. Danger, warning, caution, notice, note, important tip. There's even some custom elements that you can use if they help you there, the less for admonitions. When and how you use them is up to you. Just be consistent. Maybe follow industry practices. Warning tends to be something of physical danger, caution, just be really careful. But it's up to you to work out how you want to use them. Just be consistent. That is probably the most important thing. So each of your authors knows when... I'm sure you have some sort of style guide or playbook of how to write for your company, this should be part of it. Let's create one directly from here first. So I'm gonna go to a note and I'll click on open an editor. Oh, typical me to forget something. Paligo told me I forgot the actual name to put here. So let's do it. I've called in that example note for training, and click okay. You see Paligo has created a note for me in the pubs. Actually, you want to move it. So let's move it into topics. And we hear it's a title inside a note with the text. So I'll put some text in. And I'll create a preview so you can see, and for a second, know what the title is, because I'm gonna preview without it in a second. So let's preview it again to HTML5 with the same thing for PDF. You can see this note has the title in. Now you would just modify the CSS if you wanna change the icon. For a PDF in the layout editor, you can upload your own icons. And now let's see what happens when I remove the title. And I'll preview. By default, as you can see, Paligo added the title note. So if you want the default in here, you can put no title in. If you wanna have your own title, put this in. If you want to remove it completely, in the PDF layout editor, as far as I'm aware you can't do such a thing. In the CSS, for HTML very quickly. Just go to detail for a second. You'll see that it's called an HTML class title. You would go to the element style and put display as none, and then it's disappeared for you. If you so want to do such a thing. That's advanced just a little tip for you. Should you like it? Let's close the preview. So we've created a note. Let's go and add that note into another topic. So I'll save. And for example, I wanna put it in here. So I'd go insert component, a kind of example of reuse. And we'll go into our structure, our hierarchy, and I'll put the note in. And there's our note being used inside a bullet. And I'll say now let's create a new admonition directly inside the topic. So I'll go to adding users. I'll go after the table, and I've got three ways to put an admonition directly inside a topic or any component. Insert menu. Click on the icon, I I can add from here, or I can put a shortcut in. Or I could bring up my elements again, put a warning. And if you want, you can click this. So if it becomes one of your favorites, it'll always appear. Like if I go here now, you'll see warning top of the list as one of my favorites. And I can put some text in here. Don't touch live cables. So a similar question I've asked before, is this reusable? You all shout, no, it's not. But because I've asked the question, obviously, it can become reusable. How can I make it reusable? I can go to warning, convert reusable component, give it a name, for example, cables, And I want to leave it in here, and I'll click okay. So now as you can see, that has become another admonition in my list on the left so I can reuse it. And I've reused it here. If we go now into the cables admonition, the warning, there you go. You see, it's a warning with the content inside of it, and this by default didn't have a title as I entered it inside the topic myself. So you now should understand how to add admonitions within existing content and how to create admonitions from outside of a topic, create their own particular component and insert them into other components as well. I think I should say enjoy admonitions, but please play with them.
