Related pages: 🇫🇷 Fonctionnalités

1. Roles

Pwic.wiki relies on 5 basic roles:

• Reader
• Validator
• Editor
• Manager
• Administrator

Let's consider a digital context in which you edit a website (like the one that you are reading). You are both an administrator and a manager to contribute to the editorial line. But for security reasons, you will have a separate account to handle the administrative tasks. All your writers are editors: they can change the existing pages. The validator is optional and represents the responsible director. All your visitors are the readers and you will probably not make the website changeable like Wikipedia.

Let's consider a professional context where your team delivers a project. The administrator is responsible of the project and arbitrates the critical operations that could breach the terms and conditions. The manager is the project manager: he creates and edits the pages to structure the documentation, and allocates the work to the team. The editor is a consultant who delivers a complete documentation to the customer. The validator is the customer who approves the written pages before they can be sent to the technical team. A reader is a person interested in the project but who makes no modification at all. In case various roles collide, you can split the documentation into projects: templates, functional specifications, technical documents, etc.

2. Features

2.1. For the readers

• Access with a user account on both desktop and mobile devices
• Lightweight user interface illustrated with emojis
• Dark mode
• Homogeneous look and feel across the pages
• Encyclopedic mode to browse the latest validated revisions only
• Automatic summary of the page
• In-text search with inclusion, exclusion, hash tags and special keywords
• Search link for the browsers
• Highlight of the lines of code
• Export of a page to Markdown (.md), web page (.html) and OpenDocument (.odt)
• OData feed for BI reports
• RSS feed
• Share by link
• Share by email
• Internationalization: English, French, German, extendable to your language from a template or online
• LTR/RTL

2.2. For the validators

• Text comparison between two revisions
• No change or no deletion possible after a page is validated
• Visible control hash key

2.3. For the editors

• Page layout supervised with Markdown and HTML
• Markdown editor with syntax highlighting
• Formatting
• Annotations
• Task lists
• Classification of the pages with hashtags and statuses
• Automatic numbering of the headers with no gap
• Mandatory, linear and partially undoable versioning
• Management of attached documents by name, mime, size and magic bytes
• Import of texts from OpenDocument Text (ODT), HTML, Markdown and remote web pages

2.4. For the managers

• Dynamic tables to track the progress of the documentation by project and tag
• Copyable templates between projects
• Possible automatic KB identifier
• Detection of the orphaned pages
• Detection of the broken links
• Visual graph of the links between the pages

2.5. For the administrators

System

• Low technical requirements and bandwidth
• Affordable solution based on open-source applications
• Fast setup with Python 3 in 15 minutes
• No data stored in proprietary formats
• Local storage of the uploaded files and SQLite database
• Possible deployment with command lines
• Critical administration not available online
• Support for HTTP, HTTPS and reverse proxy
• Unicode content and URL
• HTTP logging
• IP filtering
• Expirable sessions

Pwic.wiki

• Multi-projects with dedicated authorizations by user
• Global and project-dependent settings
• OAuth2-based federated authentication with control of the state (SSO)
• Two-factor authentication based on time (2FA TOTP)
• Cache system
• Private and public modes
• Custom CSS and templates
• Export of an entire project to Markdown and HTML
• Traceable activities
• API and command line to automate the operations
• Extensible code base for the following possibilities:
  • Enhanced authorizations
  • Password control
  • Named emojis
  • Content checks
  • Content includes
  • Automatic pages
  • Redirections
  • Related pages
  • External cloud storage
  • Automatic renaming of the files
  • Bridged chat notifications
  • ...
• No JavaScript needed to read the pages in public mode

Revision #1 was last modified by gitbra
on 2024-11-30 at 00:00:00 — 90ff9794a1557980