Skip to content

Commit

Permalink
Add direct links to items in the HTML manual (#1271)
Browse files Browse the repository at this point in the history 
* fix ids to later add local links

* put titles and terms on one line

* add small space in front of headers as link target

* Remove internal links from First_Steps.xml

"First Steps is not a manual page but greeting contents."

---------

Co-authored-by: Jean-Christophe Helary <[email protected]>
  • Loading branch information
@brandelune
brandelune and Jean-Christophe Helary authored Feb 22, 2025
1 parent dd087e7 commit 47ef897
Show file tree
Hide file tree
Showing 37 changed files with 2,595 additions and 3,060 deletions.
34 changes: 17 additions & 17 deletions doc_src/en/App_ApplicationFolder.xml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "../../../docbook-xml-4.5/docbookx.dtd">
<section id="application.folder">
<title id="application.folder.title">Application Folder</title>
<title id="application.folder.title"><link linkend="application.folder"> </link>Application Folder</title>

<para>The application folder contains the <filename>OmegaT.jar</filename>
application and a number of other important files.</para>
Expand Down Expand Up @@ -44,14 +44,14 @@

<variablelist>
<varlistentry id="application.folder.omegat.license">
<term id="application.folder.omegat.license.title">OmegaT-license.txt</term>
<term id="application.folder.omegat.license.title"><link linkend="application.folder.omegat.license"> </link>OmegaT-license.txt</term>
<listitem>
<para>OmegaT's distribution license. The GPL version 3.</para>
</listitem>
</varlistentry>

<varlistentry id="application.folder.omegat.jar">
<term id="application.folder.omegat.jar.title">OmegaT.jar</term>
<term id="application.folder.omegat.jar.title"><link linkend="application.folder.omegat.jar"> </link>OmegaT.jar</term>
<listitem>
<para>OmegaT's executable. Used when launching OmegaT from the command
line. See the <link linkend="launch.with.command.line"
Expand All @@ -60,72 +60,72 @@
</varlistentry>

<varlistentry id="application.folder.changes">
<term id="application.folder.changes.title">changes.txt</term>
<term id="application.folder.changes.title"><link linkend="application.folder.changes"> </link>changes.txt</term>
<listitem>
<para>The list of improvements and bug fixes. Check it if you need
information on OmegaT's evolution.</para>
</listitem>
</varlistentry>

<varlistentry id="application.folder.doc.license">
<term id="application.folder.doc.license.title">doc-license.txt</term>
<term id="application.folder.doc.license.title"><link linkend="application.folder.doc.license"> </link>doc-license.txt</term>
<listitem>
<para>The documentation distribution license. The GPL version 3.</para>
</listitem>
</varlistentry>

<varlistentry id="application.folder.index.html">
<term id="application.folder.index.html.title">index.html</term>
<term id="application.folder.index.html.title"><link linkend="application.folder.index.html"> </link>index.html</term>
<listitem>
<para>The index to the multilingual user manual.</para>
</listitem>
</varlistentry>

<varlistentry id="application.folder.join.html">
<term id="application.folder.join.html.title">join.html</term>
<term id="application.folder.join.html.title"><link linkend="application.folder.join.html"> </link>join.html</term>
<listitem>
<para>A link to the support page.</para>
</listitem>
</varlistentry>

<varlistentry id="application.folder.readme.txt">
<term id="application.folder.readme.txt.title">readme.txt</term>
<term id="application.folder.readme.txt.title"><link linkend="application.folder.readme.txt"> </link>readme.txt</term>
<listitem>
<para>Simple installation and running instructions.</para>
</listitem>
</varlistentry>


<varlistentry id="application.folder.docs">
<term id="application.folder.docs.title">docs/</term>
<term id="application.folder.docs.title"><link linkend="application.folder.docs"> </link>docs/</term>
<listitem>
<para>The documentation folder.

<variablelist>
<varlistentry id="application.folder.docs.contributors">
<term id="application.folder.docs.contributors.title">contributors.txt</term>
<term id="application.folder.docs.contributors.title"><link linkend="application.folder.docs.contributors"> </link>contributors.txt</term>
<listitem>
<para>The list of individual contributors.</para>
</listitem>
</varlistentry>

<varlistentry id="application.folder.docs.en">
<term id="application.folder.docs.en.title">en/</term>
<term id="application.folder.docs.en.title"><link linkend="application.folder.docs.en"> </link>en/</term>
<listitem>
<para>Each translated user manual comes in a different language
folder.</para>
</listitem>
</varlistentry>

<varlistentry id="application.folder.docs.index.html">
<term id="application.folder.docs.index.html.title">index.html</term>
<term id="application.folder.docs.index.html.title"><link linkend="application.folder.docs.index.html"> </link>index.html</term>
<listitem>
<para>The index to the multilingual user manual.</para>
</listitem>
</varlistentry>

<varlistentry id="application.folder.docs.librairies.txt">
<term id="application.folder.docs.librairies.txt.title">libraries.txt</term>
<term id="application.folder.docs.librairies.txt.title"><link linkend="application.folder.docs.librairies.txt"> </link>libraries.txt</term>
<listitem>
<para>The list of libraries used by OmegaT.</para>
</listitem>
Expand All @@ -136,21 +136,21 @@
</varlistentry>

<varlistentry id="application.folder.images">
<term id="application.folder.images.title">images/</term>
<term id="application.folder.images.title"><link linkend="application.folder.images"> </link>images/</term>
<listitem>
<para>The folder where images used by OmegaT are stored.</para>
</listitem>
</varlistentry>

<varlistentry id="application.folder.lib">
<term id="application.folder.lib.title">lib/</term>
<term id="application.folder.lib.title"><link linkend="application.folder.lib"> </link>lib/</term>
<listitem>
<para>The folder where the libraries used by OmegaT are stored.</para>
</listitem>
</varlistentry>

<varlistentry id="application.folder.plugins">
<term id="application.folder.plugins.title">plugins/</term>
<term id="application.folder.plugins.title"><link linkend="application.folder.plugins"> </link>plugins/</term>
<listitem>
<para>The folder where you can install external plugins. The prefered
location for plugin manual installs is the <link
Expand All @@ -164,7 +164,7 @@
</varlistentry>

<varlistentry id="application.folder.scripts">
<term id="application.folder.scripts.title">scripts/</term>
<term id="application.folder.scripts.title"><link linkend="application.folder.scripts"> </link>scripts/</term>
<listitem>
<para>The folder where distributed scripts are located. See the <link
linkend="windows.scripts" endterm="windows.scripts.title"/> window for
Expand Down
10 changes: 5 additions & 5 deletions doc_src/en/App_Bidi.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"../../../docbook-xml-4.5/docbookx.dtd">
<section id="app.bidi">
<title id="app.bidi.title">Directional Formatting Characters</title>
<title id="app.bidi.title"><link linkend="app.bidi"> </link>Directional Formatting Characters</title>

<para>Bidi control characters are available from <link
linkend="menus.edit" endterm="menus.edit.title"/><link
Expand All @@ -29,7 +29,7 @@
show a visual indication of their position.</para>

<section id="app.bidi.marks">
<title id="app.bidi.marks.title">Marks</title>
<title id="app.bidi.marks.title"><link linkend="app.bidi.marks"> </link>Marks</title>

<para>To change the position of a character with weak or neutral
directionality (like punctuation symbols), insert an LRM or RLM character
Expand All @@ -50,7 +50,7 @@
</section>

<section id="app.bidi.embeddings">
<title id="app.bidi.embeddings.title">Embeddings</title>
<title id="app.bidi.embeddings.title"><link linkend="app.bidi.embeddings"> </link>Embeddings</title>

<para>Embeddings can be used to create a longer section of text (containing
several words and spaces) that must flow in the direction opposite that of
Expand All @@ -66,8 +66,8 @@
</listitem>
<listitem>
<para>To create a
right-to-left embedding in a left-to-right segment, insert a
right-to-left embedding (RLE) character, type or insert the right-to-left
right-to-left embedding in a left-to-right segment, insert a
right-to-left embedding (RLE) character, type or insert the right-to-left
text, and then insert the PDF character.</para>
</listitem>
</itemizedlist>
Expand Down
Loading

0 comments on commit 47ef897

Please sign in to comment.