「表記法」の版間の差分

提供: OSGeo.JP Wiki
移動: 案内検索
(なるべくliタグを使用しないよう修正)
(タグ調整)
行1: 行1:
==1.2 表記法==
+
=== Conventions ===
 
+
<span id='label_conventions'></span>
 
+
<P>
+
 
This section describes a collection of uniform styles throughout the manual.
 
This section describes a collection of uniform styles throughout the manual.
 
The conventions used in this manual are as follows:
 
The conventions used in this manual are as follows:
  
 
+
===== GUI Conventions =====
====GUI Conventions====
+
  
 
The GUI convention styles are intended to mimic the appearance of the GUI. In
 
The GUI convention styles are intended to mimic the appearance of the GUI. In
行13: 行10:
 
visually scan the GUI to find something that looks like the instruction
 
visually scan the GUI to find something that looks like the instruction
 
in the manual.
 
in the manual.
<br>
 
 
* Menu Options: {{Template:MainMenuOpt|Layer}} &gt; {{Template:DropMenuOptTwo|mActionAddRasterLayer|Add a Raster Layer}} <br>
 
:or <br>
 
:{{Template:MainMenuOpt|Settings}} &gt; {{Template:DropMenuOpt|Toolbars}} &gt; {{Template:DropMenuCheck|Digitizing}}<br><br>
 
* Tool: {{Template:ToolBtnTwo|mActionAddRasterLayer|Add a Raster Layer}}<br><br>
 
* Button: {{Template:Button|Save as Default}}<br><br>
 
* Dialog Box Title: {{Template:Dialog|Layer Properties}}<br><br>
 
* Tab: {{Template:Tab|General}}<br><br>
 
* Toolbox Item: {{Template:ToolBoxTwo|nviz.1|nviz - Open 3D-View in NVIZ}}<br><br>
 
* Checkbox: {{Template:CheckBox|Render}}<br><br>
 
* Radio Button: {{Template:RadioButtonOn|Postgis SRID}} {{Template:RadioButtonOff|EPSG ID}}<br><br>
 
* Select a Number: {{Template:SelectNumber|Hue|60}}<br><br>
 
* Select a String: {{Template:SelectString|Outline style|---Solid Line}}<br><br>
 
* Browse for a File: {{Template:BrowseButton}}<br><br>
 
* Select a Color: {{Template:SelectColor|Outline color|yellow}}<br><br>
 
* Slider: {{Template:Slider|Transparency|0}}<br><br>
 
* Input Text: {{Template:InputText|Display Name|lakes.shp}}
 
 
  
 +
<ul>
 +
<li>Menu Options: {{Template:MainMenuOpt|Layer}} > {{Template:DropMenuOptTwo|mActionAddRasterLayer|Add a Raster Layer}}<br>
 +
or<br>
 +
{{Template:MainMenuOpt|Settings}} > {{Template:DropMenuOpt|Toolbars}} > {{Template:DropMenuCheck|Digitizing}}<br><br>
 +
<li>Tool: {{Template:ToolBtnTwo|mActionAddRasterLayer|Add a Raster Layer}}<br><br>
 +
<li>Button: {{Template:Button|Save as Default}}<br><br>
 +
<li>Dialog Box Title: {{Template:Dialog|Layer Properties}}<br><br>
 +
<li>Tab: {{Template:Tab|General}}<br><br>
 +
<li>Toolbox Item: {{Template:ToolBoxTwo|nviz.1.eps|nviz - Open 3D-View in NVIZ}}<br><br>
 +
<li>Checkbox: {{Template:CheckBox|Render}}<br><br>
 +
<li>Radio Button:  {{Template:RadioButtonOn|Postgis SRID}} {{Template:RadioButtonOff|EPSG ID}}<br><br>
 +
<li>Select a Number: {{Template:SelectNumber|Hue|60}}<br><br>
 +
<li>Select a String: {{Template:SelectString|Outline style|---Solid Line}}<br><br>
 +
<li>Browse for a File: {{Template:BrowseButton}} <br><br>
 +
<li>Select a Color: {{Template:SelectColor|Outline color|yellow}}<br><br>
 +
<li>Slider: {{Template:Slider|Transparency|0|20mm}}<br><br>
 +
<li>Input Text: {{Template:InputText|Display Name|lakes.shp}}
 +
</ul>
 
A shadow indicates a clickable GUI component.
 
A shadow indicates a clickable GUI component.
  
===Text or Keyboard Conventions===
+
===== Text or Keyboard Conventions =====
  
 
The manual also includes styles related to text, keyboard commands and coding
 
The manual also includes styles related to text, keyboard commands and coding
行41: 行37:
 
correspond to any actual appearance.
 
correspond to any actual appearance.
  
<UL>
+
<ul>
<LI>Hyperlinks: http://qgis.org
+
<li>Hyperlinks: {{Template:URL|http://qgis.org}}
</LI>
+
<li>Single Keystroke: press {{Template:KeyStroke|p}}
<LI>Single Keystroke: press {{Template:KeyStroke|p}}
+
<li>Keystroke Combinations: press {{Template:KeyStroke|Ctrl+B}}, meaning press and
</LI>
+
<LI>Keystroke Combinations: press {{Template:KeyStroke|Ctrl+B}}, meaning press and
+
 
hold the Ctrl key and then press the B key.
 
hold the Ctrl key and then press the B key.
</LI>
+
<li>Name of a File: {{Template:FileName|lakes.shp}}
<LI>Name of a File: lakes.shp
+
<li>Name of a Class: {{Template:ClassName|NewLayer}}
</LI>
+
<li>Method: {{Template:Method|classFactory}}
<LI>Name of a Class: '''NewLayer'''
+
<li>Server: {{Template:Server|myhost.de}}
</LI>
+
<li>User Text: {{Template:UserText|qgis ---help}}
<LI>Method: ''classFactory''
+
</ul>
</LI>
+
<LI>Server: ''myhost.de''
+
</LI>
+
<LI>User Text: qgis --help
+
</LI>
+
</UL>
+
  
 
Code is indicated by a fixed-width font:
 
Code is indicated by a fixed-width font:
<PRE>
+
<pre>
 
PROJCS["NAD_1927_Albers",
 
PROJCS["NAD_1927_Albers",
 
   GEOGCS["GCS_North_American_1927",
 
   GEOGCS["GCS_North_American_1927",
</PRE>
+
</pre>
  
===Platform-specific instructions===
+
===== Platform-specific instructions =====
  
 
GUI sequences and small amounts of text can be formatted inline: Click
 
GUI sequences and small amounts of text can be formatted inline: Click
{{{Template:Nix}} {{Template:Win}} File {{Template:OSX}} QGIS} &gt; Quit to close QGIS. This indicates that on
+
{{{Template:Nix|}}{{Template:Win|File}} {{Template:OSX|QGIS}}} > Quit to close QGIS. This indicates that on
 
Linux, Unix and Windows platforms, click the File menu option first, then
 
Linux, Unix and Windows platforms, click the File menu option first, then
 
Quit from the dropdown menu, while on Macintosh OSX platforms, click the QGIS
 
Quit from the dropdown menu, while on Macintosh OSX platforms, click the QGIS
行76: 行64:
 
may be formatted as a list:
 
may be formatted as a list:
  
<UL>
+
<ul>
<LI>{{Template:Nix}} do this;  
+
<li>{{Template:Nix|do this;}}
</LI>
+
<li>{{Template:Win|do that;}}
<LI>{{Template:Win}} do that;  
+
<li>{{Template:OSX|do something else.}}
</LI>
+
</ul>
<LI>{{Template:OSX}} do something else.
+
</LI>
+
</UL>
+
  
 
or as paragraphs.
 
or as paragraphs.
  
{{Template:Nix}} {{Template:OSX}} Do this and this and this. Then do this and this and this
+
{{Template:Nix|}} {{Template:OSX|}} Do this and this and this. Then do this and this and this
 
and this and this and this and this and this and this.
 
and this and this and this and this and this and this.
  
{{Template:Win}}Do that. Then do that and that and that and that and that and that and
+
{{Template:Win|}}Do that. Then do that and that and that and that and that and that and
 
that and that and that and that and that and that and that and that and that.
 
that and that and that and that and that and that and that and that and that.
  

2009年10月4日 (日) 13:57時点における版

Conventions

This section describes a collection of uniform styles throughout the manual. The conventions used in this manual are as follows:

GUI Conventions

The GUI convention styles are intended to mimic the appearance of the GUI. In general, the objective is to use the non-hover appearance, so a user can visually scan the GUI to find something that looks like the instruction in the manual.

  • Menu Options: Layer > MActionAddRasterLayer.png Add a Raster Layer
    or
    Settings > Toolbars > DropMenuCheck.pngDigitizing

  • Tool: MActionAddRasterLayer.png Add a Raster Layer

  • Button: Save as Default

  • Dialog Box Title: Layer Properties

  • Tab: General

  • Toolbox Item: 19px nviz - Open 3D-View in NVIZ

  • Checkbox: CheckBox.pngRender

  • Radio Button: RadioButtonOn.png Postgis SRID RadioButtonOff.png EPSG ID

  • Select a Number: Hue60SelectNumber.png

  • Select a String: Outline style ---Solid Line SelectString.png

  • Browse for a File: ...

  • Select a Color: Outline color       

  • Slider: Transparency 0% Slider.png

  • Input Text: Display Namelakes.shp

A shadow indicates a clickable GUI component.

Text or Keyboard Conventions

The manual also includes styles related to text, keyboard commands and coding to indicate different entities, such as classes, or methods. They don't correspond to any actual appearance.

  • Hyperlinks: http://qgis.org
  • Single Keystroke: press p
  • Keystroke Combinations: press Ctrl+B, meaning press and hold the Ctrl key and then press the B key.
  • Name of a File: lakes.shp
  • Name of a Class: NewLayer
  • Method: classFactory
  • Server: myhost.de
  • User Text: qgis ---help

Code is indicated by a fixed-width font:

PROJCS["NAD_1927_Albers",
  GEOGCS["GCS_North_American_1927",
Platform-specific instructions

GUI sequences and small amounts of text can be formatted inline: Click {Nix.png Win.png File Osx.png QGIS} > Quit to close QGIS. This indicates that on Linux, Unix and Windows platforms, click the File menu option first, then Quit from the dropdown menu, while on Macintosh OSX platforms, click the QGIS menu option first, then Quit from the dropdown menu. Larger amounts of text may be formatted as a list:

  • Nix.png do this;
  • Win.png do that;
  • Osx.png do something else.

or as paragraphs.

Nix.png Osx.png Do this and this and this. Then do this and this and this and this and this and this and this and this and this.

Win.png Do that. Then do that and that and that and that and that and that and that and that and that and that and that and that and that and that and that.

Screenshots that appear throughout the user guide have been created on different platforms; the platform is indicated by the platform-specific icons at the end of the figure caption.