Craig Wright is an experienced technical writer based in Chesterfield, UK. He hates writing about himself in the third person, so I shall stop now.
Always interested in new content writing opportunities. Remote working preferred.
If you import content into MadCap Flare from another format, you may find your bullet lists are not quite right. Indents slightly wrong, nested bullet lists a bit off, etc. Here's how you can fix the code and get your bullets back where they need to be.
With large projects, Flare does not appear to handle invalid code too well (Flare 8, anyway). When I first started working with Flare, I experienced many crashes, sometimes as frequent as 2 or 3 per hour. Tidying up the HTML and incorrect unordered lists (ULs) seemed to rectify this problem.Flare's FrameMaker import creates bullet lists that look fine to the naked eye, but delve into the code and you'll see all is not quite as it should be. Sure, they look okay, but it means that the td element will control the appearance of the bullets. Correct HTML would mean the <ul> is used, not <td>.Why should you use the correct coding? How about:
If you are unfamiliar with the HTML for lists, the explanation below will hopefully help you understand how they are created. If you already know about ordered lists (numbered lists) and unordered lists (bullet lists), skip this part and go directly to Find and Fix Problems with Bullet and Number Lists.
<ul> creates a bullet list. <li> creates a list item (bullet point).</li> closes a list item.</ul> marks the end of a bullet list, but if you use <ul> again before you close a bullet list, you create a nested list (a list within a list). Each time you use <ul> without closing the previous <ul>, you create another nested level. Every nested bullet list needs to be closed separately with a </ul>.Similarly, if you want to have indented text after a list item, do not close the list item and use a <p> for the text, just like a normal paragraph. Close the text with a </p>, and then close the list item with a </li>.The HTML standard does not allow a <
>inside an <ul>, but <ul> is allowed in an <li> or an <ol>.The same rules apply for numbered lists, except that you use<ol> and </ol>.Example:<ol> <li>This is point 1.</li> <li>This is point 2.This is a line of text to provide extra information about point 2.</li> <li>This is point 3<ol> <li>This is point i.This is a line of text to provide extra information about point i.</li> <li>This is point ii.</li> <li>.This is point iii.</li></ol></li> <li>.This is point 4.</li></ol>The code above produces:
It may just be me, but I much prefer to fix existing bullet lists and number lists in plain old code. It is just easier to follow. However, if I’m writing new content and need a list, I use the list tools in Flare’s content editor, and the Make New Paragraph feature for indented text in a bullet list or number list.
If you have a large online help project, finding all of the list errors can be a bit of a pain. If your lists are in table elements, you have to find and fix them manually. To do this, you can use Flare’s search feature to look in the code for the <td> elements, but if you have lots of genuine tables, that could soon become tiresome.Finding and fixing the <p> used inside <li> errors is a little bit easier, but still not straight-forward. The simplest way I found was to:
The same approach can be used to fix <p> inside <li> elements in numbered lists (ordered lists) too.
Craig Wright is an experienced technical writer based in Chesterfield, UK. He hates writing about himself in the third person, so I shall stop now.
Always interested in new content writing opportunities. Remote working preferred.
Registered Number: 08029184
Straygoat logo design by Bristol graphic designer, Nik Jones.
© Straygoat Writing Services Ltd.