「表記法」の版間の差分

提供: OSGeo.JP Wiki
移動: 案内検索
(ページ Conventions表記法 へ移動)
(GUI Conventions)
 
(同じ利用者による、間の6版が非表示)
行1: 行1:
==1.2 Conventions==
+
=== 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===
 
 
<P>
 
 
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
 
general, the objective is to use the non-hover appearance, so a user can
 
general, the objective is to use the non-hover appearance, so a user can
行15: 行11:
 
in the manual.
 
in the manual.
  
<P>
+
<ul>
 
+
<li>Menu Options: {{Template:MainMenuOpt|Layer}} > {{Template:DropMenuOptTwo|mActionAddRasterLayer|Add a Raster Layer}}<br>
<UL>
+
or<br>
<LI>Menu Options:   [gray]0.9[gray]0.9<SPAN  CLASS="textsf">Layer</SPAN> &gt;  [rgb].95,.95,0.8[rgb].95,.95,0.8[width=3mm]mActionAddRasterLayer <SPAN  CLASS="textsf">Add a Raster Layer</SPAN>
+
{{Template:MainMenuOpt|Settings}} > {{Template:DropMenuOpt|Toolbars}} > {{Template:DropMenuCheck|Digitizing}}<br><br>
 
+
<li>Tool: {{Template:ToolBtnTwo|mActionAddRasterLayer|Add a Raster Layer}}<br><br>
<P>
+
<li>Button: {{Template:Button|Save as Default}}<br><br>
or
+
<li>Dialog Box Title: {{Template:Dialog|Layer Properties}}<br><br>
 
+
<li>Tab: {{Template:Tab|General}}<br><br>
<P>
+
<li>Toolbox Item: {{Template:ToolBoxTwo|nviz.1|nviz - Open 3D-View in NVIZ}}<br><br>
  [gray]0.9[gray]0.9<SPAN  CLASS="textsf">Settings</SPAN> &gt;  [rgb].95,.95,0.8[rgb].95,.95,0.8 <SPAN  CLASS="textsf">Toolbars</SPAN> &gt;  [rgb].95,.95,0.8[rgb].95,.95,0.8 <SPAN CLASS="MATH"></SPAN> <SPAN  CLASS="textsf">Digitizing</SPAN>
+
<li>Checkbox: {{Template:CheckBox|Render}}<br><br>
</LI>
+
<li>Radio Button:  {{Template:RadioButtonOn|Postgis SRID}} {{Template:RadioButtonOff|EPSG ID}}<br><br>
<LI>Tool: [width=7mm]mActionAddRasterLayer black[rgb]1,1,0.8<SPAN  CLASS="textsf">Add a Raster Layer</SPAN>
+
<li>Select a Number: {{Template:SelectNumber|Hue|60}}<br><br>
</LI>
+
<li>Select a String: {{Template:SelectString|Outline style|---Solid Line}}<br><br>
<LI>Button: <SPAN  CLASS="textsf">Save as Default</SPAN>
+
<li>Browse for a File: {{Template:BrowseButton}} <br><br>
 
+
<li>Select a Color: {{Template:SelectColor|Outline color|yellow}}<br><br>
</LI>
+
<li>Slider: {{Template:Slider|Transparency|0|20mm}}<br><br>
<LI>Dialog Box Title:  
+
<li>Input Text: {{Template:InputText|Display Name|lakes.shp}}
gray[rgb].95,.95,0.8<SPAN  CLASS="textbf">blackLayer Properties</SPAN>
+
</ul>
</LI>
+
<LI>Tab: <SPAN  CLASS="textsf">General</SPAN>
+
 
+
</LI>
+
<LI>Toolbox Item: [width=5mm]nviz.1.eps<SPAN  CLASS="textsf"> nviz - Open 3D-View in NVIZ</SPAN>
+
</LI>
+
<LI>Checkbox: <!-- MATH
+
$\fbox{\raisebox{-4pt}{\shadowbox{x}} \textsf{Render}}$
+
-->
+
<SPAN CLASS="MATH"></SPAN>
+
</LI>
+
<LI>Radio Button:  <SPAN CLASS="MATH"></SPAN> <SPAN  CLASS="textsf">Postgis SRID</SPAN>  <SPAN CLASS="MATH"><IMG
+
WIDTH="56" HEIGHT="32" ALIGN="MIDDLE" BORDER="0"
+
SRC="img4.png"
+
ALT="$\bigcirc$"></SPAN> <SPAN  CLASS="textsf">EPSG ID</SPAN>
+
</LI>
+
<LI>Select a Number: <!-- MATH
+
$\fbox{{Hue} \fbox{{60} \raisebox{-6pt}{\setlength{\fboxsep}{1pt}\shadowbox{${\blacktriangle}\atop{\blacktriangledown}$}}}}$
+
-->
+
<SPAN CLASS="MATH"><IMG
+
WIDTH="14" HEIGHT="24" ALIGN="MIDDLE" BORDER="0"
+
SRC="img5.png"
+
ALT="\fbox{{Hue} \fbox{{60} \raisebox{-6pt}{\setlength{\fboxsep}{1pt}\shadowbox{${\blacktriangle}\atop{\blacktriangledown}$}}}}"></SPAN>
+
</LI>
+
<LI>Select a String: <!-- MATH
+
$\fbox{\textsf{Outline style} \fbox{\textsf{- - -Solid Line} \raisebox{-2pt}{\setlength{\fboxsep}{1pt}\shadowbox{$\blacktriangledown$}}}}$
+
-->
+
<SPAN CLASS="MATH"><IMG
+
WIDTH="17" HEIGHT="28" ALIGN="MIDDLE" BORDER="0"
+
SRC="img6.png"
+
ALT="\fbox{\textsf{Outline style} \fbox{\textsf{---Solid Line} \raisebox{-2pt}{\setlength{\fboxsep}{1pt}\shadowbox{$\blacktriangledown$}}}}"></SPAN>
+
</LI>
+
<LI>Browse for a File: <SPAN CLASS="MATH"><IMG
+
WIDTH="14" HEIGHT="27" ALIGN="BOTTOM" BORDER="0"
+
SRC="img7.png"
+
ALT="$\ldots$"></SPAN>
+
 
+
</LI>
+
<LI>Select a Color: <!-- MATH
+
$\fbox{\textsf{Outline color} \raisebox{-6pt}{\setlength{\fboxsep}{0pt}\shadowbox{\setlength{\fboxsep}{2pt}\fcolorbox{yellow}{yellow}{\rule{0mm}{5mm}\rule{35mm}{0mm}}}}}$
+
-->
+
<SPAN CLASS="MATH"><IMG
+
WIDTH="175" HEIGHT="34" ALIGN="MIDDLE" BORDER="0"
+
SRC="img8.png"
+
ALT="\fbox{\textsf{Outline color} \raisebox{-6pt}{\setlength{\fboxsep}{0pt}\shadowbox...
+
...gth{\fboxsep}{2pt}\fcolorbox{yellow}{yellow}{\rule{0mm}{5mm}\rule{35mm}{0mm}}}}}"></SPAN>
+
</LI>
+
<LI>Slider: <!-- MATH
+
$\fbox{\textsf{Transparency} \textsf{0}\% \raisebox{-2pt}{\setlength{\fboxsep}{1pt}\shadowbox{$\triangledown$}}\negthinspace\rule[1mm]{20mm}{1mm}
+
}$
+
-->
+
<SPAN CLASS="MATH"><IMG
+
WIDTH="20" HEIGHT="6" ALIGN="MIDDLE" BORDER="0"
+
SRC="img9.png"
+
ALT="\fbox{\textsf{Transparency} \textsf{0}\% \raisebox{-2pt}{\setlength{\fboxsep}{1pt}\shadowbox{$\triangledown$}}\negthinspace\rule[1mm]{20mm}{1mm}
+
}"></SPAN>
+
</LI>
+
<LI>Input Text: <!-- MATH
+
$\fbox{\textsf{Display Name} \raisebox{-6pt}{\shadowbox{\texttt{lakes.shp}}}}$
+
-->
+
<SPAN CLASS="MATH"><IMG
+
WIDTH="250" HEIGHT="33" ALIGN="MIDDLE" BORDER="0"
+
SRC="img10.png"
+
ALT="\fbox{\textsf{Display Name} \raisebox{-6pt}{\shadowbox{\texttt{lakes.shp}}}}"></SPAN>
+
</LI>
+
</UL>
+
 
A shadow indicates a clickable GUI component.
 
A shadow indicates a clickable GUI component.
  
 +
===== Text or Keyboard Conventions =====
  
===Text or Keyboard Conventions===
 
 
<P>
 
 
The manual also includes styles related to text, keyboard commands and coding
 
The manual also includes styles related to text, keyboard commands and coding
 
to indicate different entities, such as classes, or methods. They don't
 
to indicate different entities, such as classes, or methods. They don't
 
correspond to any actual appearance.
 
correspond to any actual appearance.
  
<P>
+
<ul>
 
+
<li>Hyperlinks: {{Template:URL|http://qgis.org}}
<UL>
+
<li>Single Keystroke: press {{Template:KeyStroke|p}}
<LI>Hyperlinks: <TT><A NAME="tex2html1"
+
<li>Keystroke Combinations: press {{Template:KeyStroke|Ctrl+B}}, meaning press and
  HREF="http://qgis.org">http://qgis.org</A></TT>
+
</LI>
+
<LI>Single Keystroke: press .6<SPAN  CLASS="textsf">p</SPAN>
+
</LI>
+
<LI>Keystroke Combinations: press .6<SPAN  CLASS="textsf">Ctrl+B</SPAN>, 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: <TT>lakes.shp</TT>
+
<li>Name of a Class: {{Template:ClassName|NewLayer}}
</LI>
+
<li>Method: {{Template:Method|classFactory}}
<LI>Name of a Class: <SPAN  CLASS="textsf"><SPAN  CLASS="textbf">NewLayer</SPAN></SPAN>
+
<li>Server: {{Template:Server|myhost.de}}
</LI>
+
<li>User Text: {{Template:UserText|qgis ---help}}
<LI>Method: <SPAN  CLASS="textsf"><SPAN  CLASS="textit">classFactory</SPAN></SPAN>
+
</ul>
</LI>
+
<LI>Server: <SPAN  CLASS="textit">myhost.de</SPAN>
+
</LI>
+
<LI>User Text: <TT>qgis --help</TT>
+
</LI>
+
</UL>
+
  
<P>
 
 
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===
 
 
<P>
 
 
GUI sequences and small amounts of text can be formatted inline: Click
 
GUI sequences and small amounts of text can be formatted inline: Click
{[height=5mm]nix.eps [height=5mm]win.eps File [height=5mm]osx.eps 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
行150: 行64:
 
may be formatted as a list:
 
may be formatted as a list:
  
<P>
+
<ul>
 +
<li>{{Template:Nix|do this;}}
 +
<li>{{Template:Win|do that;}}
 +
<li>{{Template:OSX|do something else.}}
 +
</ul>
  
<UL>
 
<LI>[height=5mm]nix.eps do this;
 
</LI>
 
<LI>[height=5mm]win.eps do that;
 
</LI>
 
<LI>[height=5mm]osx.eps do something else.
 
</LI>
 
</UL>
 
 
<P>
 
 
or as paragraphs.
 
or as paragraphs.
  
<P>
+
{{Template:Nix|}} {{Template:OSX|}} Do this and this and this. Then do this and this and this
[height=5mm]nix.eps  [height=5mm]osx.eps  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.
  
<P>
+
{{Template:Win|}}Do that. Then do that and that and that and that and that and that and
[height=5mm]win.eps 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.
  
<P>
 
 
Screenshots that appear throughout the user guide have been created on
 
Screenshots that appear throughout the user guide have been created on
 
different platforms; the platform is indicated by the platform-specific icons
 
different platforms; the platform is indicated by the platform-specific icons
 
at the end of the figure caption.
 
at the end of the figure caption.
 
<P>
 

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

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: Nviz.1.png 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.