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.

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

Website & API Doc site generator using DocFx script #206

Merged
merged 66 commits into from
Feb 26, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
0e78fa3
Initial commit of powershell build to create an API doc site with docfx
Shazwazza May 16, 2017
98daf25
Updates styles, etc... for the docs
Shazwazza May 16, 2017
beec80a
updates build script to serve website
Shazwazza May 16, 2017
11c9cc4
updates build to properly serve with an option to not clean cache files
Shazwazza May 16, 2017
6359774
Merge remote-tracking branch 'lucene/master' into docfx-apidocs
Shazwazza Jun 30, 2017
2d362b2
adds index file for api docs
Shazwazza Jun 30, 2017
d4a90da
fixes a couple of crefs
Shazwazza Jun 30, 2017
2cf2aff
creates custom docs files
Shazwazza Jun 30, 2017
789237e
updates script to ensure it only includes csproj's that are in the sl…
Shazwazza Jun 30, 2017
d440348
Adds wiki example docs, fixes up some toc, adds logging to build, fix…
Shazwazza Jul 7, 2017
856faf5
Removes use of custom template files since we can just use the built …
Shazwazza Jul 7, 2017
710b193
Adds test files, fixing up some doc refs
Shazwazza Jul 7, 2017
7a84897
Fixes namespace overwrite issue, adds solution for custom markdown pl…
Shazwazza Jul 7, 2017
248a08f
fixes exposed name of plugin
Shazwazza Jul 7, 2017
c31809e
Moves source code for docs formatter to the 'src' folder
Shazwazza Jul 10, 2017
713c911
Merge remote-tracking branch 'lucene/master' into docfx-apidocs
Shazwazza Jul 17, 2017
a4f2717
Updates build script to ensure the custom DocFx plugin is built for t…
Shazwazza Jul 17, 2017
e5a30e1
Merge remote-tracking branch 'lucene/master' into docfx-apidocs
Shazwazza Aug 24, 2017
f311b11
Updates to latest docfx version
Shazwazza Aug 24, 2017
0efb8ab
Splitting build into separate projects so we can browse APIs per proj…
Shazwazza Sep 7, 2017
c9da684
Gets projects all building separately, added a custom toc, and now we…
Shazwazza Sep 7, 2017
eba9e22
updates build, ignore and toc
Shazwazza Sep 7, 2017
9fcf112
OK, gets projects -> namespace api docs working but the breadcrumb is…
Shazwazza Sep 7, 2017
928ba72
turns it into a 3 level toc for now which is better than before, awai…
Shazwazza Sep 7, 2017
307e6ba
Merge remote-tracking branch 'lucene/master' into docfx-apidocs
Shazwazza Sep 27, 2017
44fecfc
updates to latest docfx including the references in the docs plugin p…
Shazwazza Sep 27, 2017
07abde8
Gets CLI docs building and included as a header link and adds toc fil…
Shazwazza Sep 27, 2017
a685ced
fixes some csproj refs
Shazwazza Sep 27, 2017
981d175
adds the Kuromoji package
Shazwazza Sep 27, 2017
e3cd5bd
Gets more building, includes the markdown docs for use as the namespa…
Shazwazza Sep 27, 2017
6753ff7
removes the replicator from the docs since that was erroring for some…
Shazwazza Sep 27, 2017
eebcb6e
Moves the docfx build yml files to a better temporary folder making i…
Shazwazza Sep 28, 2017
3c94355
fixes the sln file since there was a duplicate project declared
Shazwazza Sep 28, 2017
9a3a7f7
fixes toc references
Shazwazza Sep 28, 2017
b57e572
ensure the docfx log location is absolute
Shazwazza Sep 28, 2017
0bf4876
Adds demo, removes old unused doc example files, updates and includes…
Shazwazza Oct 6, 2017
92466a6
Merge remote-tracking branch 'LUCENE/master' into docfx-apidocs
Shazwazza Nov 10, 2017
e399009
re-organizes the files that are included as files vs namespace overri…
Shazwazza Dec 22, 2017
03e5691
Get the correct /api URI paths for the generated api docs
Shazwazza Jan 8, 2018
dbdb0a2
fix whitespace for the @lucene.experimental thing to work
Shazwazza Jan 8, 2018
3a75ab7
Updates build to include TestFramework, updates index to match the ja…
Shazwazza Jan 8, 2018
c367ead
Gets the index page back to normal with the deep links to API docs, f…
Shazwazza Jan 8, 2018
ae1358b
removes duplicate entry
Shazwazza Jan 8, 2018
4774cea
removes the test framework docs from building because this causes col…
Shazwazza Jan 15, 2018
498b34e
Gets the website up and running with a nice template, updates styles …
Shazwazza Jun 5, 2018
4cce528
moves the quick start into a partial
Shazwazza Jun 5, 2018
f5dd33b
Gets most info and links all ready for the website
Shazwazza Jun 5, 2018
4410d78
Updates more docs for the website and fixes some invalid links
Shazwazza Jun 6, 2018
c7847af
commits whitespace changes as a result of a slightly different doc co…
Shazwazza Jun 6, 2018
3fe7a94
Revert "commits whitespace changes as a result of a slightly differen…
Shazwazza Jun 6, 2018
adbd663
Updates docs based on the new output of the converter
Shazwazza Jun 6, 2018
641f61d
Gets more docs converted properly with the converter
Shazwazza Jun 7, 2018
4181930
Updates the doc converter to append yaml headers correctly
Shazwazza Jun 7, 2018
d30666f
Fixes most of the xref links
Shazwazza Jun 7, 2018
544731a
Fixes link parsing in the doc converter
Shazwazza Jun 7, 2018
7ca803a
removes breadcrumb from download doc, more xrefs fixed
Shazwazza Aug 20, 2018
efb0b00
Attempting to modify the markdig markdown engine to process special t…
Shazwazza Aug 21, 2018
80c5f20
Revert "Attempting to modify the markdig markdown engine to process s…
Shazwazza Aug 21, 2018
2dd11c0
Gets the DFM markdown engine running again so the @lucene.experimenta…
Shazwazza Aug 21, 2018
99ef2ff
Updates some website info
Shazwazza Feb 19, 2019
1634932
Adds separate docs page to link to the various docs for different ver…
Shazwazza Feb 19, 2019
e288834
fix typo
Shazwazza Feb 19, 2019
7d05a79
bumps the date, small change to the source code doc
Shazwazza Feb 19, 2019
6ee616c
Gets the download page all working for the different versions with ch…
Shazwazza Feb 22, 2019
9ad9d77
Fixing links to the download-package
Tasteful Feb 24, 2019
61ab984
Merge pull request #1 from Tasteful/patch-1
Shazwazza Feb 24, 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
Prev Previous commit
Next Next commit
Adds demo, removes old unused doc example files, updates and includes…
… a few more package.md files and updates the home page with correct linking
  • Loading branch information
Shazwazza committed Oct 6, 2017
commit 0bf4876e8a3efacff754935bd34410e06f687052
5 changes: 4 additions & 1 deletion apidocs/api/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,7 @@
topicUid: Lucene.Net.Replicator
- name: Lucene.Net.ICU
href: ../obj/docfx/api/Lucene.Net.ICU/toc.yml
topicUid: Lucene.Net.Analysis.ICU
topicUid: Lucene.Net.Analysis.ICU
- name: Lucene.Net.Demo
href: ../obj/docfx/api/Lucene.Net.Demo/toc.yml
topicUid: Lucene.Net.Demo
16 changes: 0 additions & 16 deletions apidocs/docs/index.md

This file was deleted.

74 changes: 0 additions & 74 deletions apidocs/docs/search/highlight/index.md

This file was deleted.

8 changes: 0 additions & 8 deletions apidocs/docs/search/index.md

This file was deleted.

2 changes: 0 additions & 2 deletions apidocs/docs/search/toc.yml

This file was deleted.

5 changes: 0 additions & 5 deletions apidocs/docs/toc.yml

This file was deleted.

126 changes: 25 additions & 101 deletions apidocs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,116 +2,40 @@ Apache Lucene.NET™ 4.8.0 Documentation
===============

---------------


<div>
<a href="https://lucenenet.apache.org/">
<img src="https://raw.githubusercontent.com/apache/lucenenet/master/branding/logo/lucene-net-icon-128.png" title="Apache.NET Lucene Logo" alt="Lucene.NET">
</a>
<br/>
</div>

<p>Lucene is a .NET full-text search engine. Lucene.NET is not a complete application,
but rather a code library and API that can easily be used to add search capabilities
to applications.</p>
<p>
This is the official documentation for <b>Apache Lucene.NET 4.8.0</b>. Additional documentation is available <a href="docs/index.html">here</a>.
</p>
Lucene is a .NET full-text search engine. Lucene.NET is not a complete application,
but rather a code library and API that can easily be used to add search capabilities
to applications.

## Getting Started
This is the official API documentation for <b>Apache Lucene.NET 4.8.0</b>.

<p>The following section is intended as a "getting started" guide. It has three
audiences: first-time users looking to install Apache Lucene in their
application; developers looking to modify or base the applications they develop
on Lucene; and developers looking to become involved in and contribute to the
development of Lucene. The goal is to help you "get started". It does not go into great depth
on some of the conceptual or inner details of Lucene:</p>
<ul>
<li>
<a href="demo/overview-summary.html#overview_description">Lucene demo, its usage, and sources</a>:
Tutorial and walk-through of the command-line Lucene demo.</li>
<li>
<a href="core/overview-summary.html#overview_description">Introduction to Lucene's APIs</a>:
High-level summary of the different Lucene packages. </li>
<li>
<a href="core/org/apache/lucene/analysis/package-summary.html#package_description">Analysis overview</a>:
Introduction to Lucene's analysis API. See also the
<a href="core/org/apache/lucene/analysis/TokenStream.html">TokenStream consumer workflow</a>.</li>
</ul>
## Getting Started

## Reference Documents
The following section is intended as a "getting started" guide. It has three
audiences: first-time users looking to install Apache Lucene in their
application; developers looking to modify or base the applications they develop
on Lucene; and developers looking to become involved in and contribute to the
development of Lucene. The goal is to help you "get started". It does not go into great depth
on some of the conceptual or inner details of Lucene:

<ul>
<li>
<a href="changes/Changes.html">Changes</a>: List of changes in this release.</li>
<li>
<a href="SYSTEM_REQUIREMENTS.html">System Requirements</a>: Minimum and supported Java versions.</li>
<li>
<a href="MIGRATE.html">Migration Guide</a>: What changed in Lucene 4; how to migrate code from Lucene 3.x.</li>
<li>
<a href="JRE_VERSION_MIGRATION.html">JRE Version Migration</a>: Information about upgrading between major JRE versions.</li>
<li>
<a href="core/org/apache/lucene/codecs/lucene46/package-summary.html#package_description">File Formats</a>: Guide to the supported index format used by Lucene. This can be customized by using <a href="core/org/apache/lucene/codecs/package-summary.html#package_description">an alternate codec</a>.</li>
<li>
<a href="core/org/apache/lucene/search/package-summary.html#package_description">Search and Scoring in Lucene</a>: Introduction to how Lucene scores documents.</li>
<li>
<a href="core/org/apache/lucene/search/similarities/TFIDFSimilarity.html">Classic Scoring Formula</a>: Formula of Lucene's classic <a href="http://en.wikipedia.org/wiki/Vector_Space_Model">Vector Space</a> implementation. (look <a href="core/org/apache/lucene/search/similarities/package-summary.html#package_description">here</a> for other models)</li>
<li>
<a href="queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">Classic QueryParser Syntax</a>: Overview of the Classic QueryParser's syntax and features.</li>
</ul>
* [Lucene demo, its usage, and sources](xref:Lucene.Net.Demo): Tutorial and walk-through of the command-line Lucene demo.
* [Introduction to Lucene's APIs](xref:Lucene.Net): High-level summary of the different Lucene packages.
* [Analysis overview](xref:Lucene.Net.Analysis): Introduction to Lucene's analysis API. See also the [TokenStream consumer workflow](xref:Lucene.Net.Analysis.TokenStream).

## API .NET Docs
## Reference Documents

<ul>
<li style="font-size:larger; margin-bottom:.5em;">
<b><a href="api/index.html">core</a>: </b>Lucene core library</li>
<li>
<b><a href="analyzers-common/index.html">analyzers-common</a>: </b>Analyzers for indexing content in different languages and domains.</li>
<li>
<b><a href="analyzers-icu/index.html">analyzers-icu</a>: </b>Analysis integration with ICU (International Components for Unicode).</li>
<li>
<b><a href="analyzers-kuromoji/index.html">analyzers-kuromoji</a>: </b>Japanese Morphological Analyzer</li>
<li>
<b><a href="analyzers-morfologik/index.html">analyzers-morfologik</a>: </b>Analyzer for indexing Polish</li>
<li>
<b><a href="analyzers-phonetic/index.html">analyzers-phonetic</a>: </b>Analyzer for indexing phonetic signatures (for sounds-alike search)</li>
<li>
<b><a href="analyzers-smartcn/index.html">analyzers-smartcn</a>: </b>Analyzer for indexing Chinese</li>
<li>
<b><a href="analyzers-stempel/index.html">analyzers-stempel</a>: </b>Analyzer for indexing Polish</li>
<li>
<b><a href="analyzers-uima/index.html">analyzers-uima</a>: </b>Analysis integration with Apache UIMA</li>
<li>
<b><a href="benchmark/index.html">benchmark</a>: </b>System for benchmarking Lucene</li>
<li>
<b><a href="classification/index.html">classification</a>: </b>Classification module for Lucene</li>
<li>
<b><a href="codecs/index.html">codecs</a>: </b>Lucene codecs and postings formats.</li>
<li>
<b><a href="demo/index.html">demo</a>: </b>Simple example code</li>
<li>
<b><a href="expressions/index.html">expressions</a>: </b>Dynamically computed values to sort/facet/search on based on a pluggable grammar.</li>
<li>
<b><a href="facet/index.html">facet</a>: </b>Faceted indexing and search capabilities</li>
<li>
<b><a href="grouping/index.html">grouping</a>: </b>Collectors for grouping search results.</li>
<li>
<b><a href="highlighter/index.html">highlighter</a>: </b>Highlights search keywords in results</li>
<li>
<b><a href="join/index.html">join</a>: </b>Index-time and Query-time joins for normalized content</li>
<li>
<b><a href="memory/index.html">memory</a>: </b>Single-document in-memory index implementation</li>
<li>
<b><a href="misc/index.html">misc</a>: </b>Index tools and other miscellaneous code</li>
<li>
<b><a href="queries/index.html">queries</a>: </b>Filters and Queries that add to core Lucene</li>
<li>
<b><a href="queryparser/index.html">queryparser</a>: </b>Query parsers and parsing framework</li>
<li>
<b><a href="replicator/index.html">replicator</a>: </b>Files replication utility</li>
<li>
<b><a href="sandbox/index.html">sandbox</a>: </b>Various third party contributions and new ideas</li>
<li>
<b><a href="spatial/index.html">spatial</a>: </b>Geospatial search</li>
<li>
<b><a href="suggest/index.html">suggest</a>: </b>Auto-suggest and Spellchecking support</li>
<li>
<b><a href="test-framework/index.html">test-framework</a>: </b>Framework for testing Lucene-based applications</li>
</ul>
* [Changes](https://github.com/apache/lucenenet/releases/tag/Lucene.Net_4_8_0): List of changes in this release.
* [System Requirements](SYSTEM_REQUIREMENTS.html): Minimum and supported .NET versions.
* [Migration Guide](MIGRATE.html): What changed in Lucene 4; how to migrate code from Lucene 3.x.
* [File Formats](xref:Lucene.​Net.​Codecs.​Lucene46): Guide to the supported index format used by Lucene. This can be customized by using [an alternate codec](xref:Lucene.Net.Codecs).
* [Search and Scoring in Lucene](xref:Lucene.Net.Search): Introduction to how Lucene scores documents.
* [Classic Scoring Formula](xref:Lucene.Net.Search.Similarities.TFIDFSimilarity): Formula of Lucene's classic [Vector Space](http://en.wikipedia.org/wiki/Vector_Space_Model) implementation. (look [here](xref:Lucene.Net.Search.Similarities) for other models)
* [Classic QueryParser Syntax](xref:Lucene.Net.QueryParsers.Classic): Overview of the Classic QueryParser's syntax and features.
5 changes: 5 additions & 0 deletions src/Lucene.Net.QueryParser/Classic/package.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
limitations under the License.
-->

---
uid: Lucene.Net.QueryParsers.Classic
summary: *content
---

A simple query parser implemented with JavaCC.

Note that JavaCC defines lots of public classes, methods and fields
Expand Down