Sync docs after more template/starters options work

This commit is contained in:
Bill Kendrick 2023-02-12 13:47:01 -08:00
parent 7e99b05510
commit d164b7e297
15 changed files with 492 additions and 317 deletions

View file

@ -638,7 +638,7 @@ Starter Options
* If it's acceptable to crop either the top and bottom or the
left and right, use "allowscale=both". Contents from starter
will always fill the canvas, regardless of how its aspect
ratio compare to that of the canvas.
ratio compares to that of the canvas.
* The default behavior is to not allow cropping. This may be
specified explicitly with "allowscale=none".
@ -657,6 +657,9 @@ Starter Options
136") or a 6- or 3-digit-long hexadecimal 'triplet' (e.g.,
"#ff4488" or "#F48").
See the "Color Palette File" section of "Options documentation"
for further details.
gravity
This option allows you to specify how Tux Paint should position a
@ -670,7 +673,7 @@ Starter Options
bottom right is important, specify "gravity=bottom-right".
The available options are:
* center — prefer the center (the default)
* top — prefer the top center
* bottom — prefer the bottom center
* left — prefer the left center
@ -679,14 +682,33 @@ Starter Options
* top-right — prefer the top right
* bottom-left — prefer the bottom left
* bottom-right — prefer the bottom right
[ Landscape-shaped image of a horizon with the sun in the middle
and a building on the right. ]
Focusing on the center of a starter image stretched to fit the
width of the canvas.
[ Portrait-shaped image of a horizon with the sun in the middle
and the left side of building on the right. ]
Focusing on the center of a starter image stretched to fit the
height of the canvas.
[ Landscape-shaped image of the sky with the sun at the bottom and
the top of building on the right. ]
Focusing on the top of a starter image stretched to fit the width
of the canvas.
[ Landscape-shaped image of the ground with the sun at the top. ]
Focusing on the bottom of a starter image stretched to fit the
width of the canvas.
[ Portrait-shaped image of a horizon with the sun on the left and
a building in the center. ]
Focusing on the right of a starter image stretched to fit the
height of the canvas.
@ -741,8 +763,8 @@ Template Options
Translations
Tux Paint supports numerous languages, thanks to use of the "gettext"
localization library. (See "Options documentation" for how to change
locales in Tux Paint.)
localization library. (See the "Languages" section of "Options
documentation" for how to change locales in Tux Paint.)
To translate Tux Paint to a new language, copy the translation template
file, "tuxpaint.pot" (found in Tux Paint's source code, in the folder

View file

@ -786,7 +786,7 @@
</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 -->
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 compares 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 -->
@ -801,6 +801,8 @@
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>
Colors may be listed using three decimal numbers (e.g., "<code>255 68 136</code>") or a 6- or 3-digit-long hexadecimal 'triplet' (e.g., "<code>#ff4488</code>" or "<code>#F48</code>"). </p>
<p>
See the <a href="OPTIONS.html#colorfile">"Color Palette File" section of "Options documentation"</a> for further details. </p>
</dd><!-- background -->
<dt><strong>gravity</strong></dt>
@ -811,72 +813,83 @@
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> &mdash; prefer the top center</li>
<li><code><b>bottom</b></code> &mdash; prefer the bottom center</li>
<li><code><b>left</b></code> &mdash; prefer the left center</li>
<li><code><b>right</b></code> &mdash; prefer the right center</li>
<li><code><b>top-left</b></code> &mdash; prefer the top left</li>
<li><code><b>top-right</b></code> &mdash; prefer the top right</li>
<li><code><b>bottom-left</b></code> &mdash; prefer the bottom left</li>
<li><code><b>bottom-right</b></code> &mdash; prefer the bottom right</li>
</ul>
The available options are: <ul>
<li><code><b>center</b></code> &mdash; prefer the center (the default)</li>
<li><code><b>top</b></code> &mdash; prefer the top center</li>
<li><code><b>bottom</b></code> &mdash; prefer the bottom center</li>
<li><code><b>left</b></code> &mdash; prefer the left center</li>
<li><code><b>right</b></code> &mdash; prefer the right center</li>
<li><code><b>top-left</b></code> &mdash; prefer the top left</li>
<li><code><b>top-right</b></code> &mdash; prefer the top right</li>
<li><code><b>bottom-left</b></code> &mdash; prefer the bottom left</li>
<li><code><b>bottom-right</b></code> &mdash; prefer the bottom right</li>
</ul>
</p>
<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>
<figure style="text-align: center;">
<img src="../../html/images/gravity-center-landscape.png"
width="160"
height="72"
alt="[ Landscape-shaped image of a horizon with the sun in the middle and a building on the right. ]"
title="Landscape-shaped image of a horizon with the sun in the middle and a building on the right."
valign="middle" />
<figcaption style="font-size: smaller;">
<p>Focusing on the center of a starter image stretched to fit the width of the canvas.<p/>
</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>
<figure style="text-align: center;">
<img src="../../html/images/gravity-center-portrait.png"
width="84"
height="160"
alt="[ Portrait-shaped image of a horizon with the sun in the middle and the left side of building on the right. ]"
title="Portrait-shaped image of a horizon with the sun in the middle and the left side of building on the right."
valign="middle" />
<figcaption style="font-size: smaller;">
<p>Focusing on the center of a starter image stretched to fit the height of the canvas.<p/>
</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>
<figure style="text-align: center;">
<img src="../../html/images/gravity-top-landscape.png"
width="160"
height="72"
alt="[ Landscape-shaped image of the sky with the sun at the bottom and the top of building on the right. ]"
title="Landscape-shaped image of the sky with the sun at the bottom and the top of building on the right."
valign="middle" />
<figcaption style="font-size: smaller;">
<p>Focusing on the top of a starter image stretched to fit the width of the canvas.<p/>
</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>
<figure style="text-align: center;">
<img src="../../html/images/gravity-bottom-landscape.png"
width="160"
height="72"
alt="[ Landscape-shaped image of the ground with the sun at the top. ]"
title="Landscape-shaped image of the ground with the sun at the top."
valign="middle" />
<figcaption style="font-size: smaller;">
<p>Focusing on the bottom of a starter image stretched to fit the width of the canvas.<p/>
</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>
<figure style="text-align: center;">
<img src="../../html/images/gravity-right-portrait.png"
width="84"
height="160"
alt="[ Portrait-shaped image of a horizon with the sun on the left and a building in the center. ]"
title="Portrait-shaped image of a horizon with the sun on the left and a building in the center."
valign="middle" />
<figcaption style="font-size: smaller;">
<p>Focusing on the right of a starter image stretched to fit the height of the canvas.<p/>
</figcaption>
</figure>
</div>
</dd><!-- gravity -->
</dl>
@ -946,7 +959,7 @@
</header>
<p>
Tux Paint supports numerous languages, thanks to use of the "gettext" localization library. (See "Options documentation" for how to change locales in Tux Paint.) </p>
Tux Paint supports numerous languages, thanks to use of the "gettext" localization library. (See <a href="OPTIONS.html#languages">the "Languages" section of "Options documentation"</a> for how to change locales in Tux Paint.) </p>
<p>
To translate Tux Paint to a new language, copy the translation template file, "<code>tuxpaint.pot</code>" (found in Tux Paint's source code, in the folder "<code>src/po/</code>"). Rename the copy as a "<code>.po</code>" file, with an appropriate name for the locale you're translating to (e.g., "<code>es.po</code>" for Spanish; or "<code>pt_BR.po</code>" for Brazilian Portuguese, versus "<code>pt.po</code>" or "<code>pt_PT.po</code>" for Portuguese spoken in Portugal.) </p>

View file

@ -1857,7 +1857,7 @@
<section>
<header>
<h3>Color Palette File</h3>
<h3 id="colorfile">Color Palette File</h3>
</header>
<dl>