Skip to content

Commit

Permalink
Guide: small typo (PR #2165)
Browse files Browse the repository at this point in the history
  • Loading branch information
oscarlevin authored and rbeezer committed Jun 6, 2024
1 parent 4ae8599 commit 257cde8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/guide/author/overview.xml
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
<title>Images</title>
<idx>image</idx>

<p>You can include an image via the <tag>image</tag><idx>image</idx> tag, using the <attr>source</attr> attribute to provide a filename, likely prefixed by a relative path from the top-level of the appropriate directory. Read <xref ref="processing-directory-management"/> for details on how to set these directories correctly. If you are starting a new project, using the <pretext />-CLI (with the command <c>pretext new book</c>, for example), then most of the setup portion is done for you and the top-level directory for images that are created external to the project is called <c>assests</c>, and it is a sibling of the <c>source</c> directory. It is your responsibility to locate that file properly relative to this directory, and that the file format is compatible. So, for example, suppose your source contained <c>&lt;image source="images/butterflies.jpg"/&gt;</c>. Then you would want to have a directory named <c>images</c> below wherever you set the <attr>external</attr> top-level directory, and you would place the <c>butterflies.jpg</c> file inside of the <c>images</c> directory.</p>
<p>You can include an image via the <tag>image</tag><idx>image</idx> tag, using the <attr>source</attr> attribute to provide a filename, likely prefixed by a relative path from the top-level of the appropriate directory. Read <xref ref="processing-directory-management"/> for details on how to set these directories correctly. If you are starting a new project, using the <pretext />-CLI (with the command <c>pretext new book</c>, for example), then most of the setup portion is done for you and the top-level directory for images that are created external to the project is called <c>assets</c>, and it is a sibling of the <c>source</c> directory. It is your responsibility to locate that file properly relative to this directory, and that the file format is compatible. So, for example, suppose your source contained <c>&lt;image source="images/butterflies.jpg"/&gt;</c>. Then you would want to have a directory named <c>images</c> below wherever you set the <attr>external</attr> top-level directory, and you would place the <c>butterflies.jpg</c> file inside of the <c>images</c> directory.</p>

<p>The <attr>width</attr> attribute can be used to control the size of the image. Widths are expressed as a percentage of the available width, such as <c>width="60%"</c>. Instead of a width, you can also specify margins and the width will be deduced.</p>

Expand Down

0 comments on commit 257cde8

Please sign in to comment.