====== Quick Start Guide ====== Welcome to Lexipedia! This guide will get you up and running as an editor. Whether you're here to document a legal process, create a BPMN diagram, or simply fix a typo, this page covers everything you need to know. ---- ===== 1. Getting an Account ===== To edit pages on Lexipedia, you need a registered account. Click **Register** in the top-right corner of any page, fill in the form, and you're ready to go. Once logged in, you'll see **Edit** buttons on every page section and a pencil icon in the right-hand toolbar. ---- ===== 2. DokuWiki Editing Basics ===== Lexipedia runs on [[https://www.dokuwiki.org|DokuWiki]], a lightweight, file-based wiki engine. Editing is done through simple text markup — no special software required. ==== Creating and Editing Pages ==== To edit an existing page, click the **pencil icon** on the right side of the page, or click any section's **Edit** button. To create a new page, simply link to a page name that doesn't exist yet (e.g., ''[[my new page]]''), save, then click the red link to create it. ==== Text Formatting ==== ^ What you type ^ What you get ^ | ''**bold text**'' | **bold text** | | ''//italic text//'' | //italic text// | | ''__underlined__'' | __underlined__ | | ''''monospaced'''' | ''monospaced'' | ==== Headings ==== DokuWiki uses equals signs for headings. More equals signs means a higher-level heading (the opposite of some other wikis): ====== Level 1 Heading (Page Title) ====== ===== Level 2 Heading ===== ==== Level 3 Heading ==== === Level 4 Heading === Headings automatically generate the **Table of Contents** you see in the sidebar. ==== Links ==== ^ Type ^ Syntax ^ Example ^ | Internal link | ''[[page name]]'' | [[start]] | | Named link | ''[[page name|Display Text]]'' | [[start|Home Page]] | | External link | ''[[https://example.com|Example]]'' | [[https://www.dokuwiki.org|DokuWiki]] | ==== Lists ==== * Unordered item (two spaces + asterisk) * Another item * Nested item (four spaces + asterisk) - Ordered item (two spaces + dash) - Another item ==== Tables ==== Tables use ''|'' for cells and ''^'' for header cells: ^ Header 1 ^ Header 2 ^ | Cell 1 | Cell 2 | | Cell 3 | Cell 4 | ==== Images and Media ==== Upload images through the **Media Manager** (top menu bar), then embed them: {{image.png}} - full size {{image.png?200}} - 200px wide {{image.png?200x150}} - 200x150px ==== Useful Shortcuts ==== * ''----'' creates a horizontal rule * ''...'' creates a code block * ''...'' prevents wiki formatting from being processed For the complete reference, see the [[https://www.dokuwiki.org/wiki:syntax|official DokuWiki syntax guide]]. ---- ===== 3. Understanding BPMN ===== **BPMN** (Business Process Model and Notation) is the backbone of Lexipedia. It's an international standard (ISO 19510) for visually diagramming business processes, and it's how we represent legal and civic procedures as clear, step-by-step flowcharts. ==== Why BPMN? ==== Legal processes are often buried in dense statutory text. BPMN diagrams make them visual and executable. If you can read a flowchart, you can read a BPMN diagram. For a deeper look at the rationale, see the [[overview|Project Overview]]. ==== Core BPMN Elements ==== Here are the building blocks you'll encounter and use: ^ Element ^ Symbol ^ What It Means ^ | **Start Event** | Circle (thin border) | Where the process begins | | **End Event** | Circle (thick border) | Where the process concludes | | **Task** | Rounded rectangle | A single unit of work (e.g., "File application") | | **Gateway (Exclusive)** | Diamond | A decision point — the flow takes one path (e.g., "Approved?" → Yes/No) | | **Gateway (Parallel)** | Diamond with + | All outgoing paths are followed simultaneously | | **Sequence Flow** | Arrow | Shows the order of steps | | **Pool / Lane** | Large horizontal box | Represents a participant or department | ==== How BPMN Is Used in Lexipedia ==== Each legal process entry in Lexipedia (see the [[sample_entry|Sample Entry template]]) includes a BPMN model section. BPMN diagrams are stored as XML and rendered visually in the wiki. The typical workflow is: - **Design** the process model using an AI-assisted tool like [[https://github.com/sartography|bpmn-assistant]] or a visual editor like [[https://demo.bpmn.io|bpmn.io]] - **Export** the diagram as BPMN XML (.bpmn file) - **Embed** the XML in a Lexipedia wiki page using the BPMN plugin in the editor - **Discuss and refine** with the community - **Deploy** to [[https://www.spiffworkflow.org/|SpiffWorkflow]] for executable process automation See [[process|How We Process Our Data]] for a diagram of this pipeline. ==== Creating Your First BPMN Diagram ==== The easiest way to get started: - Go to [[https://demo.bpmn.io|bpmn.io demo editor]] — it's free and runs in your browser - Drag elements from the palette to build your process - Click the **download** icon to save the .bpmn XML file - Copy the XML content and paste it into your Lexipedia page's BPMN section You can also use AI assistants (Claude, ChatGPT, Gemini) to generate BPMN XML from a plain-language description of a process. Just describe the steps and ask for BPMN 2.0 XML output, then paste the result into the wiki. See the [[documentation|technical documentation]] for more on this approach. ---- ===== 4. Understanding DMN ===== **DMN** (Decision Model and Notation) is BPMN's companion standard. While BPMN models the //flow// of a process, DMN models the //decisions// within it. ==== What Is DMN? ==== DMN provides a way to define business decisions using decision tables, which look a lot like spreadsheets. Each row represents a rule: "If these conditions are met, then here's the result." For example, in a business licensing process, a DMN table might capture: ^ Business Type ^ Revenue ^ License Required ^ | Restaurant | Any | Food Service License | | Retail | > $500k | Large Retail Permit | | Retail | ≤ $500k | Standard Business License | ==== How DMN Fits into Lexipedia ==== In Lexipedia process models, you'll often find a BPMN task labeled something like "Determine License Type." That task's logic is defined by a DMN decision table. Together, BPMN and DMN give you the complete picture: the process flow (BPMN) and the rules driving each decision (DMN). DMN tables can also be executed in [[https://www.spiffworkflow.org/|SpiffWorkflow]], turning static documentation into working automation. ==== Creating a DMN Table ==== - Go to [[https://demo.bpmn.io/dmn|bpmn.io DMN editor]] — free, browser-based - Define your **inputs** (the conditions, like "Business Type") and **outputs** (the result, like "License Required") - Fill in the rules row by row - Export the DMN XML and include it in your Lexipedia page alongside the BPMN model ---- ===== 5. Lexipedia Page Structure ===== Most Lexipedia process documentation follows the structure shown in the [[sample_entry|Sample Entry]]. Here's a simplified overview of the key sections: * **Overview** — A plain-language summary of what the process is and who it's for * **Quick Facts** — Process type, jurisdiction, risk level, and regulatory framework * **BPMN Model** — The visual diagram and embedded XML * **Process Components** — Actors (who's involved), key steps, and decision points * **Legal Context** — Regulatory requirements, risk controls, and applicable laws * **Implementation** — Technical requirements and documentation needed * **Governance** — Decision rights, audit trails, and escalation paths * **Cross References** — Links to related processes, external standards, and regulations You don't need to fill out every section for every page. Start with what you know and the community will help fill in the rest. ---- ===== 6. Your First Contribution ===== Here are some easy ways to make your first edit: * **Fix a typo or clarify wording** — Every page has an Edit button. Small improvements matter. * **Add a missing link** — If you notice a reference that should link to another page, add the ''[[brackets]]''. * **Create a process stub** — Pick a legal process you know well, create a new page, and add a basic overview. Others can help add the BPMN model. * **Review and discuss** — Use the Discussion section at the bottom of any page to ask questions or suggest improvements. * **Request a model** — Visit the [[requests|Request Models]] page to suggest processes that should be documented. ---- ===== 7. Key Links ===== * [[start|Home Page]] — Back to the main page * [[overview|Project Overview]] — The vision behind Lexipedia * [[Community Guidelines]] — How we collaborate * [[sample_entry|Sample Entry Template]] — The standard page structure * [[documentation|Technical Documentation]] — Detailed docs on data processing * [[process|How We Process Data]] — The BPMN pipeline behind Lexipedia * [[Jurisdictions]] — Browse models by location * [[Categories]] — Browse models by topic * [[requests|Request Models]] — Suggest new processes to document * [[https://www.dokuwiki.org/wiki:syntax|DokuWiki Syntax Reference]] — Complete formatting guide * [[https://demo.bpmn.io|bpmn.io Editor]] — Free BPMN diagram editor * [[https://demo.bpmn.io/dmn|bpmn.io DMN Editor]] — Free DMN decision table editor * [[https://www.spiffworkflow.org/|SpiffWorkflow]] — The workflow engine Lexipedia models deploy to ---- ===== 8. Getting Help ===== * **Discussion sections** — Every page has one at the bottom. Ask questions, flag issues, or suggest edits. * **Community Guidelines** — Read the [[Community Guidelines]] for communication norms and collaboration practices. * **Recent Changes** — Check [[https://www.lexipedia.xyz/doku.php?do=recent|Recent Changes]] to see what others are working on and find pages that need attention. Welcome aboard — we're glad you're here.