Using the page editor

The page editor is where you construct a formatted page containing multiple paragraphs, bullets, indented text, links to other documents, and graphics. Several of the topics in the Documentation Editor use the page editor.

The page editor is not like a standard word processor where you enter text and apply a format (paragraph, bullets, indents, and so forth). Rather, you must first add a page element, such as a paragraph, bullet, or indented paragraph, then enter text. The reason for this is that the documentation you write is saved with the tool or toolbox as XML, which puts constraints on how you enter text.

Learn more about XML

The page editor contains two panels, the content panel and the text entry panel, and a toolbar, as shown below.

The content panel may be initially empty, as in the case of the Summary topic, or it may contain a predefined tree view, as in the case of the Parameters topic. Regardless of whether the content panel is empty or predefined, you can still add page elements and text.

Using the page editor involves the following:

• Add a page element (such as a paragraph or bullet) by clicking one of the page element buttons, described below.
The page element will be added after the selected page element in the content section tree view.
• Select the page element in the content panel to enter text for that element.
The text entry panel will change depending on the page element selected.

Toolbar button	Action performed
	Adds a new paragraph.
	Adds a bulleted paragraph.
	Adds a link. The link can refer to any document that can be displayed in a web browser, such as a Word document, PDF, graphics file, or Excel spreadsheet, to name a few. You can also enter a Web address. The address must start with http:// (for example, http://www.esri.com). The name is displayed on the page. If you have two successive links, add a paragraph between them. Otherwise, they will appear on the same line. Entering a path name to a document on your computer impacts the portability of the tool or toolbox. Learn more about sharing tools and toolboxes
	Adds a graphic. Name text will appear as a tool tip when the mouse is hovered over the graphic. Entering a pathname to a graphic on your computer impacts the portability of the tool or toolbox. Learn more about sharing tools and toolboxes
	Adds a new subsection. The user can expand or collapse the subsection.
	Adds a new indented section.
	Removes one level of indentation. This only applies to a nested indent (an indent within an indent), as shown below.
	Moves the selected page element up in the table contents.
	Moves the selected page element down in the table contents.
	Deletes the selected page element.