rcp-help/src/main/docbook/3.1.4.2_annotations.xml

<!--
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements.  See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership.  The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License.  You may obtain a copy of the License at
	
	http://www.apache.org/licenses/LICENSE-2.0
	
	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied.  See the License for the
	specific language governing permissions and limitations
	under the License.
-->
<section id="annotations">
	<title>Annotations</title>
	<para>
		The following preferences can be changed on the
		<emphasis role="strong">Text Editors > Annotations</emphasis>
		preference page.
	</para>
	<para>
		<informaltable>
			<tgroup cols="2">
				<colspec colname="Option" colwidth="1* " />
				<colspec colname="Description" colwidth="2*" />
				<colspec colname="Default" colwidth="1*" />
				<thead>
					<row>
						<entry>Option</entry>
						<entry>Description</entry>
					</row>
				</thead>
				<tbody>
					<row>
						<entry>Show in Text as</entry>
						<entry>
							This option controls whether the selected
							annotation type is shown in the text. The
							corresponding text will be underlined with
							squiggles or highlighted.
						</entry>
					</row>
					<row>
						<entry>Show in Overview ruler</entry>
						<entry>
							This option controls whether the overview
							ruler on the right side of the text editor
							is shown.
						</entry>
					</row>
					<row>
						<entry>Show in Vertical ruler</entry>
						<entry>
							This option controls whether the selected
							annotation type is shown in the vertical
							ruler.
						</entry>
					</row>
					<row>
						<entry>Color</entry>
						<entry>
							This option controls the color for the
							selected annotation type.
						</entry>
					</row>
				</tbody>
			</tgroup>
		</informaltable>
	</para>
	<para>
		Here is what the Annotations preferences page looks like:
	</para>
	<para>
		<screenshot>
			<mediaobject>
				<imageobject>
					<imagedata scale="50"
						fileref="images/annotations_screen.png" format="PNG" />
				</imageobject>
			</mediaobject>
		</screenshot>
	</para>
</section>