Skip to content
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

Jump to bottom

New initial section on requirements, as suggested by @ebeshero. #259

Closed
wants to merge 1 commit into from
Closed

New initial section on requirements, as suggested by @ebeshero. #259

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions schema/staticSearch.odd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,29 @@
</front>
<body>
<head>Project Endings staticSearch Generator</head>



<div xml:id="whatDoesItNeed">
<head>What do I need in order to use this?</head>
<p>In order to build a static search index on your document collection,
you will need:</p>

<list>
<item>A collection of <ref target="https://www.lesliesikos.com/xhtml5-the-zenith-of-markup-languages/">XHTML5 documents</ref> (HTML documents which are in the XHTML namespace
and are well-formed). </item>
<item>A computer running Linux or Mac OSX (the indexing process does not yet work on Windows, although
you could use the Windows Subsystem for Linux to run it)</item>
<item>Java, <ref target="https://ant.apache.org/">Apache Ant</ref>, and <ref target="https://ant-contrib.sourceforge.net/">ant-contrib</ref> installed on the system.</item>
</list>

<p>Once you have run the indexing process on your document collection, you can place the results
on any web server and the search will work with any modern browser. The requirements above
are only for building the search index, which you only need to do once (until your documents
change).</p>

</div>

<div xml:id="whatDoesItDo">
<head>What does it do?</head>
<list>
Expand Down