Difference between revisions of "Inkscape glossary"

From Inkscape Wiki
Jump to navigation Jump to search
Line 1: Line 1:
This is a beginning of an Inkscape glossary. Please respect it and contribute to it if you work on Inkscape UI. If you are doing translations, please create and link below a similar glossary for your language.
This is a beginning of an Inkscape glossary. Please respect it and contribute to it if you work on Inkscape UI. If you are doing translations, please create and link below a similar glossary for your language.


==General==
=General=


=== Objects ===
== Objects ==
* '''Object''': an independent editable thing on the canvas. May be a path, a shape, a text object, a group, etc.
* '''Object''': an independent editable thing on the canvas. May be a path, a shape, a text object, a group, etc.


Line 36: Line 36:
* '''Clone''':
* '''Clone''':


=== Canvas ===
== Canvas ==


* '''Document''':
* '''Document''':
Line 48: Line 48:
* '''Guide''':
* '''Guide''':


==User Interface==
= User Interface =


=== Document window ===  
== Document window ==
The main window, displaying the Canvas, Menus, Commands Bar, Toolbox, Tool Controls Bar, Status Bar, etc. Note that the same instance of the program may have several document windows. Some dialog are referred to as "windows" therefore it is important to distinguish between them and the Document window.  
The main window, displaying the Canvas, Menus, Commands Bar, Toolbox, Tool Controls Bar, Status Bar, etc. Note that the same instance of the program may have several document windows. Some dialog are referred to as "windows" therefore it is important to distinguish between them and the Document window.  


=== Canvas ===
== Canvas ==
Main part, with optional border, rulers and scrollbars
Main part, with optional border, rulers and scrollbars


=== Menu ===
== Menu ==
Bar at the top.  
Bar at the top.  


=== Toolbox ===
== Toolbox ==
Displaying the Tools icons, along the left side
Displaying the Tools icons, along the left side


==== Selector tool ====
=== Selector tool ===
==== Node tool ====
=== Node tool ===
==== Zoom tool ====
=== Zoom tool ===
==== Rectangle tool ====
=== Rectangle tool ===
==== Ellipse tool ====
=== Ellipse tool ===
==== Star tool ====
=== Star tool ===
==== Spiral tool ====
=== Spiral tool ===
==== Pencil tool ====
=== Pencil tool ===
To preserve consistency, please do not refer to this tool as freehand tool. Pencil tool (freehand) is better to use.
To preserve consistency, please do not refer to this tool as freehand tool. Pencil tool (freehand) is better to use.
==== Pen tool ====
=== Pen tool ===
To preserve consistency, please do not refer to this tool as Bezier tool. Pen tool (Bezier) is better to use.
To preserve consistency, please do not refer to this tool as Bezier tool. Pen tool (Bezier) is better to use.
==== Calligraphy tool ====
=== Calligraphy tool ===
==== Text tool ====
=== Text tool ===
==== Gradient tool ====
=== Gradient tool ===
==== Color dropper tool ====
=== Color dropper tool ===


=== Commands bar ===
== Commands bar ==
Beneath the Menu, with buttons for commands like New, Open, ... Note that this one will likely be broken into many smaller toolbars, each covering one topic, so the user will be able to switch them on/off and rearrange. So this name is temporary.  
Beneath the Menu, with buttons for commands like New, Open, ... Note that this one will likely be broken into many smaller toolbars, each covering one topic, so the user will be able to switch them on/off and rearrange. So this name is temporary.  


=== Tool Controls bar ===
== Tool Controls bar ==
Beneath the Commands bar. Has the controls for the currently active tool. Note the capitalization. One should not refer to it as the "Tool bar," nor is it a "Tool" edition of the "controls" variety of "bar". It's proper name should be "Tool Controls" bar.  
Beneath the Commands bar. Has the controls for the currently active tool. Note the capitalization. One should not refer to it as the "Tool bar," nor is it a "Tool" edition of the "controls" variety of "bar". It's proper name should be "Tool Controls" bar.  


=== Status bar ===
== Status bar ==
Along the bottom side of the window
Along the bottom side of the window


=== Rulers ===
== Rulers ==


=== Scrollbar ===
== Scrollbar ==


== Dialog Boxes ==
= Dialog Boxes =
From wikipedia: Dialog boxes are special windows which are used by computer programs or by the operating system to display information to the user, or to get a response if needed. They are so-called because they form a dialog between the computer and the user—either informing the user of something, or requesting input from the user, or both.
From wikipedia: Dialog boxes are special windows which are used by computer programs or by the operating system to display information to the user, or to get a response if needed. They are so-called because they form a dialog between the computer and the user—either informing the user of something, or requesting input from the user, or both.


=== Fill and Stroke ===
== Fill and Stroke ==


=== Gradients ===
== Gradients ==


=== Swatches ===
== Swatches ==


=== Text and fonts ===
== Text and fonts ==


=== Align and Distribute ===
== Align and Distribute ==


=== Tile Clones ===
== Tile Clones ==


=== Global Preferences ===
== Global Preferences ==


=== Document Preferences ===
== Document Preferences ==


=== Document Metadata ===
== Document Metadata ==


=== XML Editor ===
== XML Editor ==


== Verbs (actions on objects) ==
= Verbs (actions on objects) =


== Effects ==
= Effects =
* Fretboard designer
* Fretboard designer
* Generate from path
* Generate from path
Line 122: Line 122:
* Modify path
* Modify path


==Depreceated terms==
= Depreceated terms =
These are used inside the code. Never use them for documentation.
These are used inside the code. Never use them for documentation.


Line 129: Line 129:
* desktop (use "canvas" or "document window" depending on context)
* desktop (use "canvas" or "document window" depending on context)
* event contexts (they are known to users as "tools")
* event contexts (they are known to users as "tools")
= Words being used as verbs and names =
Translators, pay attention to those words that can be used in the interface either as verbs either as names
* Group
* Clone

Revision as of 10:23, 15 June 2006

This is a beginning of an Inkscape glossary. Please respect it and contribute to it if you work on Inkscape UI. If you are doing translations, please create and link below a similar glossary for your language.

General

Objects

  • Object: an independent editable thing on the canvas. May be a path, a shape, a text object, a group, etc.
  • Path: object, with nodes, but without handles. For example a line created using the Freehand tool.
  • Live Shape: an object that does not display nodes but may have controls. An example is a circle or star. A live shape can be converted to path by Convert to Path command.
  • Node: point of a path that you can manipulate with. If you use Node tool, then it is displayed as gray or blue (if selected) rectangle on a path. Shapes do not have nodes, only handles. Node can have one or two handles too - displayed as circles connected to node. They modify Bezier's tangents.
  • Handle:
    • One of two points around a node, displayed (for selected nodes) as a circle connected with its node by a line (node handles);
    • The arrows around the selected object in selector (scale handles, rotation handles);
    • Points on a shape that can be dragged by node tool to edit the shape, displayed as small white diamonds (shape handles);
    • The things that you drag on canvas to set the placement, direction, and size of a gradient or pattern (gradient handles, pattern handles). Internally this is called a Knot, but this is a deprecated term in user documentation.
  • Stroke: a visible outline of a shape or path. Not the same as path; a path may or may not have a stroke. If the stroke is present, it can be converted to path by Convert Stroke to Path command.
    • Stroke shape (to be implemented): the dependency of the stroke width on distance along the stroke. Currently only constant-width strokes are supported.
    • Stroke pattern (to be implemented): the representation of a stroke as a sequence of arbitrary objects positioned along the path.
  • Fill:
  • Pattern:
  • Gradient:
  • Text:
  • Group:
  • Layer:
  • Clone:

Canvas

  • Document:
  • Canvas:
  • Page:
  • Grid:
  • Guide:

User Interface

Document window

The main window, displaying the Canvas, Menus, Commands Bar, Toolbox, Tool Controls Bar, Status Bar, etc. Note that the same instance of the program may have several document windows. Some dialog are referred to as "windows" therefore it is important to distinguish between them and the Document window.

Canvas

Main part, with optional border, rulers and scrollbars

Menu

Bar at the top.

Toolbox

Displaying the Tools icons, along the left side

Selector tool

Node tool

Zoom tool

Rectangle tool

Ellipse tool

Star tool

Spiral tool

Pencil tool

To preserve consistency, please do not refer to this tool as freehand tool. Pencil tool (freehand) is better to use.

Pen tool

To preserve consistency, please do not refer to this tool as Bezier tool. Pen tool (Bezier) is better to use.

Calligraphy tool

Text tool

Gradient tool

Color dropper tool

Commands bar

Beneath the Menu, with buttons for commands like New, Open, ... Note that this one will likely be broken into many smaller toolbars, each covering one topic, so the user will be able to switch them on/off and rearrange. So this name is temporary.

Tool Controls bar

Beneath the Commands bar. Has the controls for the currently active tool. Note the capitalization. One should not refer to it as the "Tool bar," nor is it a "Tool" edition of the "controls" variety of "bar". It's proper name should be "Tool Controls" bar.

Status bar

Along the bottom side of the window

Rulers

Scrollbar

Dialog Boxes

From wikipedia: Dialog boxes are special windows which are used by computer programs or by the operating system to display information to the user, or to get a response if needed. They are so-called because they form a dialog between the computer and the user—either informing the user of something, or requesting input from the user, or both.

Fill and Stroke

Gradients

Swatches

Text and fonts

Align and Distribute

Tile Clones

Global Preferences

Document Preferences

Document Metadata

XML Editor

Verbs (actions on objects)

Effects

  • Fretboard designer
  • Generate from path
  • Render
  • Modify path

Depreceated terms

These are used inside the code. Never use them for documentation.

  • knot (this may be a "handle", "control", "node" etc as seen by the user)
  • item (use "object")
  • desktop (use "canvas" or "document window" depending on context)
  • event contexts (they are known to users as "tools")

Words being used as verbs and names

Translators, pay attention to those words that can be used in the interface either as verbs either as names

  • Group
  • Clone