Sync'ing docs & adding images for Starter/Template options files
This commit is contained in:
Bill Kendrick
parent
72914158dd
commit
82d5c0c4e7
19 changed files with 1545 additions and 30 deletions
|
|
@ -93,12 +93,12 @@
|
|||
バージョン 0.9.29 </h1>
|
||||
|
||||
<p>
|
||||
Copyright © 2002-2022 by various contributors; <a href="../../AUTHORS.txt">AUTHORS.txt</a> 参照.<br>
|
||||
Copyright © 2002-2023 by various contributors; <a href="../../AUTHORS.txt">AUTHORS.txt</a> 参照.<br>
|
||||
<a href="https://tuxpaint.org/">https://tuxpaint.org/</a>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
2022年6月 4日 </p>
|
||||
2023年2月12日 </p>
|
||||
</center>
|
||||
</header>
|
||||
|
||||
|
|
@ -125,9 +125,12 @@
|
|||
<li><a href="#stamps_images">Stamp Images</a></li> <li><a href="#description_text">Stamp Descriptive Text</a></li> <li><a href="#sound_effects">Stamp Sound Effects</a></li> <li><a href="#descriptive_sound">Stamp Descriptive Sound</a></li> <li><a href="#stamp_options">Stamp Options</a></li> <li><a href="#pre_mirroed_and_flipped_images">Pre-Mirrored and Flipped Stamps</a></li> </ul>
|
||||
</li>
|
||||
<li><a href="#fonts">フォント</a></li> <li><a href="#starters">'Starters'</a> <ul>
|
||||
<li><a href="#coloring_book_style">Coloring-Book Style Starters</a></li> <li><a href="#scene_style">Scene-Style Starters</a></li> </ul>
|
||||
<li><a href="#coloring_book_style">Coloring-Book Style Starters</a></li> <li><a href="#scene_style">Scene-Style Starters</a></li> <li><a href="#starter_options">Starter Options</a></li> </ul>
|
||||
</li>
|
||||
<li><a href="#templates">'Templates'</a></li> <li><a href="#translations">Translations</a></li> <li><a href="#input_methods">Alternative Input Methods</a></li> <li><a href="#on_screen_keyboard">画面キーボード</a></li> </ul>
|
||||
<li><a href="#templates">'Templates'</a> <ul>
|
||||
<li><a href="#template_options">Template Options</a></li> </ul>
|
||||
</li>
|
||||
<li><a href="#translations">Translations</a></li> <li><a href="#input_methods">Alternative Input Methods</a></li> <li><a href="#on_screen_keyboard">画面キーボード</a></li> </ul>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
@ -712,6 +715,177 @@
|
|||
|
||||
<p class="note">
|
||||
<span title="Information">💡</span> <strong>Note:</strong> 'Starters' are 'attached' to saved pictures, via a small text file that has the same name as the saved file, but with "<code>.dat</code>" as the extension. This allows it to continue to affect the drawing even after Tux Paint has been quit, or another picture is loaded or a new image is created. (In other words, if you base a drawing on a 'starter' image, it will always be affected by it.) </p>
|
||||
|
||||
<section><!-- H2: Starter Options -->
|
||||
<header>
|
||||
<h2>
|
||||
<a name="starter_options"
|
||||
id="starter_options">Starter Options</a>
|
||||
</h2>
|
||||
</header>
|
||||
|
||||
<p>
|
||||
Aside from an image, starters can also be given other attributes. To do this, you need to create a 'data file' for the starter. (Note: Tux Paint prior to version 0.9.29 did not support starter options.) </p>
|
||||
|
||||
<p>
|
||||
A starter's data file is simply a plain ASCII text file containing the options for the starter. </p>
|
||||
|
||||
<p>
|
||||
The file has the same name as the image, but a "<code>.dat</code>" extension. (e.g., "<code>starter.png</code>"'s data file is the text file "<code>starter.dat</code>", found in the same directory.) </p>
|
||||
|
||||
<dl>
|
||||
<dt><strong>allowscale</strong></dt>
|
||||
<dd><!-- allowscale -->
|
||||
<p>
|
||||
When a starter image is a different aspect ratio (width-to-height proportions) than Tux Paint's canvas, by default it will be scaled to fit entirely within the canvas, without stretching the starter (changing its aspect ratio); for example, a square starter on a portrait-shaped canvas will be placed in the center of the canvas. By default, Tux Paint will then take the strip of pixels at the edges of the starter and stretch them to the edges of the canvas, "smearing" it. </p>
|
||||
|
||||
<center>
|
||||
<img src="../../html/images/smear-wide.png"
|
||||
width="320"
|
||||
height="153"
|
||||
alt=""
|
||||
valign="middle" />
|
||||
<img src="../../html/images/smear-tall.png"
|
||||
width="216"
|
||||
height="320"
|
||||
alt=""
|
||||
valign="middle" />
|
||||
</center>
|
||||
|
||||
<p>
|
||||
If it's acceptable for the starter image to be cropped in one or both directions, the "<code><b>allowscale</b></code>" may be used to tell Tux Paint which behavior to allow: </p>
|
||||
<ul>
|
||||
<li><!-- allowscale=horizontal -->
|
||||
<img src="../../html/images/allowscale-horizontal.png"
|
||||
width="108"
|
||||
height="160"
|
||||
alt=""
|
||||
align="right">
|
||||
For starters where it's <em>alright to crop the left and right edges</em>, but the top and bottom edges must be retained, use "<code><b>allowscale=horizontal</b></code>". <ul>
|
||||
<li>
|
||||
If the starter's aspect ratio is wider than that of the canvas, it will be scaled to fit the height of the canvas, and the left and right will be cropped. </li>
|
||||
<li>
|
||||
If the starter's aspect ratio is taller than that of the canvas, it will be scaled to fit the height of the canvas, and no cropping will occur, and the left and right edges will be smeared. </li>
|
||||
</ul>
|
||||
<br clear="all" />
|
||||
</li><!-- allowscale=horizontal -->
|
||||
|
||||
<li><!-- allowscale=vertical -->
|
||||
<img src="../../html/images/allowscale-vertical.png"
|
||||
width="240"
|
||||
height="115"
|
||||
alt=""
|
||||
align="right">
|
||||
For starters where it's <em>alright to crop the top and bottom edges</em>, but the left and right edges must be retained, use "<code><b>allowscale=vertical</b></code>". <ul>
|
||||
<li>
|
||||
If the starter's aspect ratio is taller than that of the canvas, it will be scaled to fit the width of the canvas, and the top and bottom will be cropped. </li>
|
||||
<li>
|
||||
If the starter's aspect ratio is wider than that of the canvas, it will be scaled to fit the width of the canvas, and no cropping will occur, and the top and bottom edges will be smeared. </li>
|
||||
</ul>
|
||||
<br clear="all" />
|
||||
</li><!-- allowscale=vertical -->
|
||||
|
||||
<li><!-- allowscale=both -->
|
||||
If it's acceptable to crop either the top and bottom or the left and right, use "<code><b>allowscale=both</b></code>". Contents from starter will always fill the canvas, regardless of how its aspect ratio compare to that of the canvas. </li><!-- allowscale=both -->
|
||||
|
||||
<li><!-- allowscale=none -->
|
||||
The default behavior is to not allow cropping. This may be specified explicitly with "<code><b>allowscale=none</b></code>". </li><!-- allowscale=none -->
|
||||
</ul>
|
||||
</dd><!-- allowscale -->
|
||||
|
||||
<dt><strong>background</strong></dt>
|
||||
<dd><!-- background -->
|
||||
<p>
|
||||
This option allows you to specify how Tux Paint should fill the rest of the canvas, when the starter does not fit in one or the other direction. By default, as described above, Tux Paint will "smear" the pixels from the edges of the starter. (This can be specified explicitly with "<code><b>background=smear</b></code>".) </p>
|
||||
<p>
|
||||
You can instead specify a solid background color (e.g., white for a 'coloring-book' style starter, with "<code><b>background=#fff</b></code>"). </p>
|
||||
<p>
|
||||
各行の色は、３つの十進数の組み（例: "<code>255 68 136</code>"）、あるいは、3つの16 進数の組からなる6桁または3桁の表記（例: "<code>#ff4488</code>" または "<code>#F48</code>”）で指定します。 </p>
|
||||
</dd><!-- background -->
|
||||
|
||||
<dt><strong>gravity</strong></dt>
|
||||
<dd><!-- gravity -->
|
||||
<p>
|
||||
This option allows you to specify how Tux Paint should position a starter, when it is being cropped in one or the other direction. By default, Tux Paint will place the center of the starter within the canvas. (This can be specified explicitly with "<code><b>gravity=center</b></code>".) </p>
|
||||
<p>
|
||||
For example, if the top center of the starter contains the most important content, you can specify "<code><b>gravity=top</b></code>". Or, if the bottom right is important, specify "<code><b>gravity=bottom-right</b></code>". </p>
|
||||
|
||||
<p>
|
||||
The available options are: </p>
|
||||
<ul>
|
||||
<li><code><b>top</b></code> — prefer the top center</li>
|
||||
<li><code><b>bottom</b></code> — prefer the bottom center</li>
|
||||
<li><code><b>left</b></code> — prefer the left center</li>
|
||||
<li><code><b>right</b></code> — prefer the right center</li>
|
||||
<li><code><b>top-left</b></code> — prefer the top left</li>
|
||||
<li><code><b>top-right</b></code> — prefer the top right</li>
|
||||
<li><code><b>bottom-left</b></code> — prefer the bottom left</li>
|
||||
<li><code><b>bottom-right</b></code> — prefer the bottom right</li>
|
||||
</ul>
|
||||
|
||||
<div style="display: inline-block; border: 1px solid #888; width: 320px;">
|
||||
<figure style="text-align: center;">
|
||||
<img src="../../html/images/gravity-center-landscape.png"
|
||||
width="160"
|
||||
height="72"
|
||||
alt=""
|
||||
valign="middle" />
|
||||
<figcaption style="font-size: smaller;">
|
||||
Focusing on the center of a starter image stretched to fit the width of the canvas. </figcaption>
|
||||
</figure>
|
||||
</div>
|
||||
<div style="display: inline-block; border: 1px solid #888; width: 320px;">
|
||||
<figure style="text-align: center;">
|
||||
<img src="../../html/images/gravity-center-portrait.png"
|
||||
width="84"
|
||||
height="160"
|
||||
alt=""
|
||||
valign="middle" />
|
||||
<figcaption style="font-size: smaller;">
|
||||
Focusing on the center of a starter image stretched to fit the height of the canvas. </figcaption>
|
||||
</figure>
|
||||
</div>
|
||||
<div style="display: inline-block; border: 1px solid #888; width: 320px;">
|
||||
<figure style="text-align: center;">
|
||||
<img src="../../html/images/gravity-top-landscape.png"
|
||||
width="160"
|
||||
height="72"
|
||||
alt=""
|
||||
valign="middle" />
|
||||
<figcaption style="font-size: smaller;">
|
||||
Focusing on the top of a starter image stretched to fit the width of the canvas. </figcaption>
|
||||
</figure>
|
||||
</div>
|
||||
<div style="display: inline-block; border: 1px solid #888; width: 320px;">
|
||||
<figure style="text-align: center;">
|
||||
<img src="../../html/images/gravity-bottom-landscape.png"
|
||||
width="160"
|
||||
height="72"
|
||||
alt=""
|
||||
valign="middle" />
|
||||
<figcaption style="font-size: smaller;">
|
||||
Focusing on the bottom of a starter image stretched to fit the width of the canvas. </figcaption>
|
||||
</figure>
|
||||
</div>
|
||||
<div style="display: inline-block; border: 1px solid #888; width: 320px;">
|
||||
<figure style="text-align: center;">
|
||||
<img src="../../html/images/gravity-right-portrait.png"
|
||||
width="84"
|
||||
height="160"
|
||||
alt=""
|
||||
valign="middle" />
|
||||
<figcaption style="font-size: smaller;">
|
||||
Focusing on the right of a starter image stretched to fit the height of the canvas. </figcaption>
|
||||
</figure>
|
||||
</div>
|
||||
</dd><!-- gravity -->
|
||||
</dl>
|
||||
|
||||
<p class="note">
|
||||
<span title="Information">💡</span> <strong>Note:</strong> Templates (described below) may also have options files, and currently support all of the same options as starters. </p>
|
||||
<br clear="all">
|
||||
</section><!-- H2: Starter Options -->
|
||||
|
||||
</section><!-- H1: Starters -->
|
||||
|
||||
<section class="indent outer"><!-- H1: 'Templates' -->
|
||||
|
|
@ -748,6 +922,19 @@
|
|||
<p class="note">
|
||||
<span title="Information">💡</span> <strong>Note:</strong> 'Templates' are 'attached' to saved pictures, via a small text file that has the same name as the saved file, but with "<code>.dat</code>" as the extension. This allows it to continue to affect the drawing even after Tux Paint has been quit, or another picture is loaded or a new image is created. (In other words, if you base a drawing on a 'template' image, it will always be affected by it.) </p>
|
||||
<br clear="all">
|
||||
|
||||
<section><!-- H2: Template Options -->
|
||||
<header>
|
||||
<h2>
|
||||
<a name="template_options"
|
||||
id="template_options">Template Options</a>
|
||||
</h2>
|
||||
</header>
|
||||
|
||||
<p>
|
||||
Like 'starters', a configuration file may be specified that defines how Tux Paint should behave when applying 'template' images to the canvas when they do not have identical proportions (aspect ratio). See "Starter Options", above. (Note: Tux Paint prior to version 0.9.29 did not support template options.) </p>
|
||||
</section><!-- H2: Template Options -->
|
||||
|
||||
</section><!-- H1: 'Templates' -->
|
||||
|
||||
<section class="indent outer"><!-- H1: Translations -->
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue