PBworks User Manual

 

TOC

Page history last edited by Adam Ruf 9 mos ago

How to add a Table of Contents (TOC) to a page 

 

 

What is the TOC plugin?

The TOC (table of contents) plugin allows you to display a linked table at the top of the page. Clicking on lines in the TOC takes you to a point in the workspace page with the same title.

 

Here is the TOC for this page. Notice when you rest your mouse cursor over any of the lines in the TOC, you can click them and jump to that section of the page.

 


 

Setting up your page to use a TOC

When you are typing stuff into your page, keep in mind the major sections you want to divide it into. When you have a section you want to make appear in your TOC, you need to format it with the the Format option in the editor Toolbar. Choose the H1, H2, or H3 format. Only lines that are formatted with the Hx will show in the TOC.

 

Here I am setting up the sections on this page for the TOC. I choose H1 for the most important (title section) part. and H2 or H3 for the less important sections.

 

 

When I'm done, the title is H1 and the subsections of the page are H2. I rarely use H3, but you may find it handy to have sub-subsections.

 

 

 

Inserting the TOC

After you have your page formatted with the H1, H2 or H3 formats, you can insert your TOC plugin. Just click the "Insert Plugin" button, select the Table of Contents plugin from the PBworks Magic category and follow the steps, as shown below.

 

 

 

 

 

 

Problems with the TOC

1. Never use too many H1, H2 or H3 formats in the page. Nobody likes a complicated TOC. Try to keep the Hx formats to a single line of text in each position. Don't format an entire paragraph with H1, H2 or H3.

 

2. If you want a line to appear in the TOC, don't put a Page link or URL link in it. It may not work right and it may be confusing if it does work.

 

3. Be very careful with other formatting on the Hx lines. Try not to change the color of the text or make it bold or italics.

 

5. Please do not use more then 1 TOC per page, and avoid using the TOC on the SideBar page.


Adding a Return to Top of the Page link

 

 

Adding a pound sign (#) to the end of any page's web address, such as http://usermanual.pbworks.com/TOC#, is the crucial part of creating a Return to the Top link.  That pound sign is what tells your browser to take you to the top of the page.

 

So, to create a link to bring readers back to the top of a page, just copy the page's web address from your browser's address bar and add the pound sign at the end.  (Example: http://usermanual.pbworks.com/TOC# is the web address that will direct a user's browser to the top of this page).

 

Then, use the Insert/Edit Link tool from the Toolbar and choose "URL" for the type of link. Paste in the web address and click "OK" to insert the link.

 

Furthermore, if you change the link text, you can change the link's appearance so that it's instantly clear what clicking on the link will do (see below example).

 

Go to the top