Skip to content

General review, follow-on to mavenized documentation #342 #345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
duncdrum merged 8 commits into from
May 22, 2019
Merged

General review, follow-on to mavenized documentation #342 #345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5fd8dc6
Remove unreferenced assets
joewiz May 19, 2019
8d2b984
Adjust navigation header
joewiz May 19, 2019
ec367ef
Remove reference to Wolfgang’s laptop
joewiz May 19, 2019
238ede6
Review documentation TOC
joewiz May 19, 2019
d0c59f4
Remove xml extension from internal article links
joewiz May 19, 2019
3a0682b
Audit HTTP links, switch to HTTPS where supported
joewiz May 19, 2019
cb268c5
Normalize intra-app links, esp fundocs
joewiz May 19, 2019
4c2ed83
Correct section ID based on title change
joewiz May 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/xar-resources/data/advanced-installation/listings/listing-2.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Wolfgangs-MacBook-Air:eXist wolf$ java -jar exist-installer/target/exist-installer-5.0.0-RC8-SNAPSHOT.jar
$ java -jar exist-installer/target/exist-installer-5.0.0-RC8-SNAPSHOT.jar
Select target path [/Users/wolf/Source/trunk/eXist]
/Applications/eXist/
press 1 to continue, 2 to quit, 3 to redisplay
Expand Down
2 changes: 1 addition & 1 deletion src/main/xar-resources/data/ant-tasks/ant-tasks.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

<!-- ================================================================== -->

<para>eXist-db provides a library for the <link xlink:href="http://ant.apache.org"
<para>eXist-db provides a library for the <link xlink:href="https://ant.apache.org"
><code>Ant</code></link> build tool to automate common system administration and
operation tasks, like backup/restore or importing files. The latest version of eXist-db's
Ant Tasks can be found on Maven Central as the artifact <link xlink:href="https://search.maven.org/search?q=g:org.exist-db%20AND%20a:exist-ant">exist-ant</link>.</para>
Expand Down
12 changes: 6 additions & 6 deletions src/main/xar-resources/data/author-reference/author-reference.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<info>
<title>Author Reference</title>
<date>1Q18</date>
<date>2Q19</date>
<keywordset>
<keyword>authoring</keyword>
<keyword>exist</keyword>
Expand Down Expand Up @@ -162,7 +162,7 @@ but does not because its too simple)</programlisting>
<title>Technical guidelines</title>

<para>More information about DocBook itself can be found on the <link condition="_blank"
xlink:href="http://docbook.org/">official DocBook site</link>.</para>
xlink:href="https://docbook.org/">official DocBook site</link>.</para>

<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

Expand Down Expand Up @@ -589,7 +589,7 @@ but does not because its too simple)</programlisting>
<para>A <tag>tag</tag> element surrounds its content with &lt; and &gt; and
formats it like code. Meant to make life easier:
<code><![CDATA[<tag>xxx</tag>]]></code> is the shorter version of
<code><![CDATA[<code>&lt;xxx&gt;</code>]]></code>.</para>
<code><![CDATA[<code><xxx></code>]]></code>.</para>
</listitem>
</varlistentry>

Expand Down Expand Up @@ -633,9 +633,9 @@ but does not because its too simple)</programlisting>
<para>Links to external sources are done with the <tag>link</tag> element.
Place the target's full URI in the <code>xlink:href</code> attribute.
For instance,
<code><![CDATA[&amp;lt;link xlink:href="http://exist-db.org/exist/apps/homepage/index.html"&amp;gt;]]></code>
<tag>link xlink:href="https://exist-db.org/exist/apps/homepage/index.html"</tag>
links to the <link condition="_blank"
xlink:href="http://exist-db.org/exist/apps/homepage/index.html">eXist
xlink:href="https://exist-db.org/exist/apps/homepage/index.html">eXist
home page</link>.</para>
<para>To open the link on a new page, add
<code>condition="_blank"</code>.</para>
Expand All @@ -649,7 +649,7 @@ but does not because its too simple)</programlisting>
use the <tag>link</tag> element. However, use the target's document name
(without the <code>.xml</code> extension) as the link address. For
instance,
<code><![CDATA[&amp;lt;link xlink:href="documentation"&amp;gt;]]></code>
<tag>link xlink:href="documentation"</tag>
links to the <link xlink:href="documentation">documentation home
page</link>.</para>
</listitem>
Expand Down
2 changes: 1 addition & 1 deletion src/main/xar-resources/data/backup/backup.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@
<programlisting xlink:href="listings/listing-6.txt"/>
<para>You can also subscribe to the notifications made available by the SanityReport
MBean to be informed of sanity check results. Please consult eXist-db's <link
xlink:href="jmx.xml">JMX documentation</link> on how to configure this.</para>
xlink:href="jmx">JMX documentation</link> on how to configure this.</para>
</sect3>

</sect2>
Expand Down
20 changes: 10 additions & 10 deletions src/main/xar-resources/data/basic-installation/basic-installation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@
environment. Java comes in a number of versions, so it is important that you use the
version that eXist-db requires: Java 8 (since eXist-db 3.0). For instructions about
running Java on your operating system, see Oracle's <link condition="_blank"
xlink:href="http://www.java.com/en/download/help/index_installing.xml">Installing
Java</link> page. <link condition="_blank" xlink:href="http://openjdk.java.net"
xlink:href="https://www.java.com/en/download/help/index_installing.xml">Installing
Java</link> page. <link condition="_blank" xlink:href="https://openjdk.java.net"
>OpenJDK</link> is a good open source alternative to the Oracle JVM and known to
work well with eXist-db.</para>
<para>eXist-db runs with both the Java JRE (Java Runtime Environment) and the JDK (Java
Expand All @@ -64,7 +64,7 @@
on commercial Linux distributions. Users of other distributions are better served by
distribution-specific instructions. More information for specific versions of Linux
can be found at <link condition="_blank"
xlink:href="http://livingtao.blogspot.com/2012/01/few-easy-steps-to-install-sunoracle-jdk.html"
xlink:href="https://livingtao.blogspot.com/2012/01/few-easy-steps-to-install-sunoracle-jdk.html"
>Amazon Linux</link>, <link condition="_blank"
xlink:href="http://www.webupd8.org/2012/01/install-oracle-java-jdk-7-in-ubuntu-via.html"
>Ubuntu</link> and <link condition="_blank"
Expand Down Expand Up @@ -95,7 +95,7 @@
<itemizedlist>
<listitem>
<para>Download the installer by following the download link on the <link
xlink:href="http://exist-db.org/">eXist-db homepage</link> page. We recommend
xlink:href="https://exist-db.org/">eXist-db homepage</link> page. We recommend
that you download the latest stable release.</para>
<para>The installer is a single file called
<literal>eXist-db-setup-[version].jar</literal> (for instance
Expand All @@ -109,7 +109,7 @@
<code>.jar</code> file.</para>
<note>
<para>On Mac OS X 10.7 and higher, a security feature called <link
xlink:href="http://support.apple.com/kb/HT5290">Gatekeeper</link>
xlink:href="https://support.apple.com/kb/HT5290">Gatekeeper</link>
may prevent the installer from running since eXist-db is not
registered with Apple. To circumvent the warning dialog and allow
the installer to run, right-click or control-click the file and
Expand All @@ -131,7 +131,7 @@
</listitem>
<listitem>
<para>More advanced installation methods (like installing on a headless system) are
described in the <link xlink:href="advanced-installation.xml#headless">Advanced
described in the <link xlink:href="advanced-installation#headless">Advanced
Installation</link> article. If you wish to compile and run exist from source
please see the article on <link xlink:href="exist-building.xml">building
eXist</link></para>
Expand Down Expand Up @@ -252,7 +252,7 @@

<note>
<para>eXist-db can also be run as a background service. For more information see the
<link xlink:href="advanced-installation.xml#headless">Advanced Installation</link>
<link xlink:href="advanced-installation#headless">Advanced Installation</link>
article.</para>
</note>

Expand Down Expand Up @@ -318,14 +318,14 @@
<literal>bin/</literal> sub-directory. On Linux or Mac, enter
<code>bin/startup.sh</code>, on Windows <code>bin\startup.bat</code>. More
information about these start-up scripts in the <link
xlink:href="advanced-installation.xml#headless">Advanced Installation</link>
xlink:href="advanced-installation#headless">Advanced Installation</link>
article.</para>

<note>
<title>Having trouble?</title>
<para>If you're having trouble launching eXist-db, see our articles on <link
xlink:href="troubleshooting">Troubleshooting</link> and <link
xlink:href="advanced-installation.xml#headless">Advanced
xlink:href="advanced-installation#headless">Advanced
Installation</link>.</para>
</note>
</sect2>
Expand All @@ -351,7 +351,7 @@
</mediaobject>
</informalfigure>
<para>Seeing it? Congratulations! (Not seeing it? See our article on <link
xlink:href="troubleshooting.xml">Troubleshooting</link>).</para>
xlink:href="troubleshooting">Troubleshooting</link>).</para>

<para>All right, ready to dive in! Your local installation includes everything you need.
Access is easy, through the applications on the <link xlink:href="{dashboard}/"
Expand Down
25 changes: 13 additions & 12 deletions src/main/xar-resources/data/beginners-guide-to-xrx-v4/beginners-guide-to-xrx-v4.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<info>
<title>Creating CRUDS applications with XRX in eXist</title>
<date>1Q18</date>
<date>2Q19</date>
<keywordset>
<keyword>getting-started</keyword>
<keyword>application-development</keyword>
Expand Down Expand Up @@ -57,7 +57,7 @@
<para>To use this guide you will need to have following tools in place: </para>
<orderedlist>
<listitem>
<para> <emphasis role="bold">eXist</emphasis>: You will need to have <link xlink:href="http://exist-db.org">eXist</link> running on your local system.
<para> <emphasis role="bold">eXist</emphasis>: You will need to have <link xlink:href="https://exist-db.org">eXist</link> running on your local system.
By default eXist runs on port <code>8080</code> so that when you set your
web browser to <link xlink:href="http://localhost:8080/exist/">http://localhost:8080/exist/</link> you should see the eXist homepage come
up.</para>
Expand Down Expand Up @@ -101,7 +101,7 @@
<para>This example will use the following terms and concepts:</para>
<para> <emphasis role="bold">XRX</emphasis> is the name of the web application
architecture that we are introducing in this guide. The term XRX comes from the
combination of XForms, REST, and XQuery. The term was <link xlink:href="http://archive.oreilly.com/pub/post/xrx_a_simple_elegant_disruptiv_1.html">coined</link> by Dan McCreary. XForms are used in the client (web browser), REST is
combination of XForms, REST, and XQuery. The term was <link xlink:href="https://web.archive.org/web/20171224124316/http://archive.oreilly.com/pub/post/xrx_a_simple_elegant_disruptiv_1.html">coined</link> by Dan McCreary. XForms are used in the client (web browser), REST is
the interface between the client and the server, and XQuery is the server language.
Two of the most significant advantages of XRX over other architectures are: (1) it
does not require users to translate data into Java or .Net objects, and (2) it does
Expand Down Expand Up @@ -235,7 +235,8 @@
interchange of applications, the EXPath Community has created a specification
for application metadata, called EXPath Packaging System. eXist supports and
extends this module. This tutorial will not cover this file's structure, but you
can learn more about this by reading <link xlink:href="https://exist-db.org/exist/apps/doc/repo.xml"/>. </para>
can learn more about this by reading about the <link xlink:href="repo">Package
Repository</link>. </para>
</listitem>
</orderedlist>
<para>You are always free to change the names of the collection or the queries, but as
Expand Down Expand Up @@ -400,7 +401,7 @@
also creates a Lucene full text index for all words in the term name, term
definition and term publish-status-code. (By using the repo.xml Deployment
Descriptor's "prepare" field, you can automate the installation of this
collection.xconf file into the target location; see <link xlink:href="https://exist-db.org/exist/apps/doc/repo.xml#D1.4.10"/>.)</para>
collection.xconf file into the target location; see <link xlink:href="repo#D1.4.10"/>.)</para>
</sect2>

<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
Expand Down Expand Up @@ -585,7 +586,7 @@
allows users to enter multi-line descriptions for definitions of terms. The last
control is the <tag>xf:select1</tag> control that allows the user to select one
value from a list of values. (For a complete discussion of the XForms controls we
suggest you use the XForms Wikibook at <link xlink:href="http://en.wikibooks.org/wiki/XForms">http://en.wikibooks.org/wiki/XForms</link>. The Input Form Controls section goes
suggest you use the XForms Wikibook at <link xlink:href="https://en.wikibooks.org/wiki/XForms">http://en.wikibooks.org/wiki/XForms</link>. The Input Form Controls section goes
through each of the controls in the XForms specification. In addition to the
standard controls there are other controls that can also be integrated directly into
XForms, such as rich-text editors.)</para>
Expand Down Expand Up @@ -709,7 +710,7 @@
<para>Create an XQuery module to centralize some of the common code and reduce
duplication and then reference these functions in each of your queries. For
example, you could put the HTML boilerplate into a style module. You could also
explore eXist's HTML templating module; see <link xlink:href="https://exist-db.org/exist/apps/doc/templating.xml"/>.</para>
explore eXist's <link xlink:href="templating">HTML templating module</link>.</para>
</listitem>
<listitem>
<para>Change the <code>list-items.xq</code> to use HTML tables to view each
Expand Down Expand Up @@ -769,7 +770,7 @@
<listitem>
<para>Modify the collection configuration file for the
<code>/db/apps/terms/data</code> collection to enable versioning when items are
updated. See <link xlink:href="https://exist-db.org/exist/apps/doc/versioning.xml"/>.</para>
updated. See <link xlink:href="versioning">Versioning Extensions</link>.</para>
</listitem>
</orderedlist>
</sect1>
Expand All @@ -785,22 +786,22 @@
<para>Wiki Books:</para>
<itemizedlist>
<listitem>
<para> <link xlink:href="http://en.wikibooks.org/wiki/XForms">XForms Wikibook</link> </para>
<para> <link xlink:href="https://en.wikibooks.org/wiki/XForms">XForms Wikibook</link> </para>
<para>Dan McCreary</para>
</listitem>
<listitem>
<para> <link xlink:href="http://en.wikibooks.org/wiki/XRX">XRX Wikibook</link> </para>
<para> <link xlink:href="https://en.wikibooks.org/wiki/XRX">XRX Wikibook</link> </para>
<para>Dan McCreary</para>
</listitem>
<listitem>
<para> <link xlink:href="http://en.wikibooks.org/wiki/XQuery">XQuery Wikibook</link> </para>
<para> <link xlink:href="https://en.wikibooks.org/wiki/XQuery">XQuery Wikibook</link> </para>
<para>Chris Wallace; Dan McCreary</para>
</listitem>
</itemizedlist>
<para>Articles:</para>
<itemizedlist>
<listitem>
<para> <link xlink:href="http://en.wikipedia.org/wiki/XRX_%28web_application_architecture%29">XRX (web application architecture)</link> </para>
<para> <link xlink:href="https://en.wikipedia.org/wiki/XRX_%28web_application_architecture%29">XRX (web application architecture)</link> </para>
</listitem>
<listitem>
<para> <link xlink:href="http://news.oreilly.com/2008/07/xrx-xqueries-in-exist.html">XRX: XQueries in eXist</link> </para>
Expand Down
Loading