Wiki portal operations

Updated 2026-09-24. This guide describes the PHP publication included in this package.

Open the site

With the project in the XAMPP document root and Apache running, open http://localhost/openforex.io/. The reader requires no database, build step, or Wiki.js service. The shared-hosting package provides the same reader through public_html/index.php.

Content catalog

The reader indexes Markdown from seed-content, docs, developer, foundation, community, and legal. Visitor pages now include Start here, Resource library, TVX learning lab, Developer hub, Contribute, and My reading list. It displays each file as an article and includes its text in browser-side search. New documents become visible automatically; this is a public publication mechanism, not a private draft workspace.

Root and shared-hosting articles are synchronized in this edition, including the complete foundational TVX literature. Update both distributions when preparing later releases.

Reader features

Use the sidebar for section entry points, the literature index for the complete collection, or Ctrl K for full-text search. Article contents links are generated from headings. Download Markdown provides the current article text. The displayed reading time is an approximate word-count estimate.

Article reading, navigation links, and downloads work without JavaScript. Search, filtering, the mobile navigation toggle, and generated article contents use JavaScript.

Repository configuration

Set OPENFOREX_REPOSITORY_URL in the server environment to the official HTTPS repository destination. The source article replaces its repository marker with that link when a valid destination is supplied. Until then it explains the destination's availability accurately.

Donation and sponsorship destinations are not configured by the repository variable. Publish verified support arrangements in the Foundation support article when they exist.

Deployment and assets

The root entry point sets a relative asset prefix; the package entry point uses its own assets directory. CSS, JavaScript, and SVG icon definitions are local. Fonts use Google Fonts with system fallbacks. The blue, teal, cyan, slate, and restrained gold palette is documented in the brand guide.

Operational checks

Request the homepage, representative documents, CSS, JavaScript, and a Markdown download. Confirm an unknown article returns 404. Inspect search and mobile navigation in a browser and read tables, blockquotes, and long headings at narrow widths.

Keep secrets and backup archives outside indexed content and public web directories. Retain a recoverable copy before deploying new source or content. The application does not maintain revision history on its own.

See architecture, shared hosting, content structure, and API reference.

Visitor tools

The resource library combines full-text filtering, collection selection, and title or reading-time sorting. Filter state is represented in its URL. A read-only JSON catalog is available through ?format=catalog; its contract is documented in developer/publication-api.md.

Saved articles and manual reading progress use browser local storage under openforex-reading-v1. Accessibility preferences use openforex-accessibility-v1. These features do not create accounts or send their stored state to the server. When storage is unavailable, controls retain an in-memory state for the current page and explain that limit. Reading lists can be exported as Markdown.

The QASH reference calculator imports the unmodified compiled TVX SDK from assets/vendor/tvx/index.js, sourced from the shipped 0.1.0 tarball. Preserve its license and provenance files. Presets are illustrative. Exports record input provenance, arithmetic inputs and output policy. The authority publication status is shown separately from entered values. Input changes hide a stale result until recalculated.

The contribution builder creates a Markdown download on the visitor's device. It has no submission backend. Keep the distinction between preparing a brief and submitting it through an available repository channel clear.

Implementation files: includes/portal.php, assets/css/portal.css, assets/js/portal.js, and assets/js/lab.js. Guided paths reference catalog IDs; check every step when renaming content. Keep new guide documents synchronized in the root and shared-hosting distributions.