Files
2026-07-10 00:20:29 +02:00

1.7 KiB

page, help, title, package, access, kind, backend_java
page help title package access kind backend_java
htroot/Help.html help/Help.md Tutorial core-search-public public ui-page source/net/yacy/htroot/Help.java

Tutorial

Purpose

Tutorial links users to YaCy help and learning material.

Use it as an entry point when the user is lost in the interface.

What You Can Do Here

  • Tutorial links users to YaCy help and learning material.
  • Choose query, target, content type, or integration options according to the user intent.
  • Keep ordinary read-only viewing separate from authenticated actions that alter stored data.

Page Architecture

Public search pages turn request parameters into result lists, previews, snippets, feeds, or integration fragments. They are mostly read-oriented, but some result actions can bookmark, recommend, blacklist, or delete references when authenticated.

Correct Use

Start from the user's information need. Use query text, content type, collection, URL filters, and pagination to narrow results. Do not mix ordinary search with authenticated result actions unless the user explicitly asks to modify stored data.

Access And Safety

The page is normally public or read-only, unless the peer is configured to require authentication for all pages.

Automation And API

Page backend: source/net/yacy/htroot/Help.java.

No request parameters are needed for normal use of this page.

What To Expect

Expect rendered search or content output: result lists, snippets, previews, redirects, widgets, or fragments. If output is empty, check whether the index contains matching documents before changing query syntax.

  • Related search work usually continues on yacysearch.html, index.html, ViewFile.html, quick crawl, or the search integration pages.