Personal tools

Sponsorname

Your company could advertise here

www.fla-consulting.eu

Contribute to GxPlex: Difference between revisions

From GxPlex

Jump to: navigation, search
← Older edit
Update contribution instructions to reflect PageForms-based workflow
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Contribute to GxPlex ==
== How to Contribute ==


Registered users can create and edit content in GxPlex. This page explains how, as a user —
This page explains how GxPlex is structured and how to add or edit content.
not a developer.


=== Creating a new page ===
=== Wiki structure ===


# Log in with your user account.
GxPlex uses four types of pages:
# Go to [[GxPlex:New page|Create new page]].
# Choose what you want to create:
#* '''Document''' — a regulatory document (law, guideline, regulation, ...).
#* '''Reference''' — a specific part of a document (article, section, paragraph, ...), linked to the Document it belongs to.
#* '''Normal page''' — any other content, with no info-box.
# For Document and Reference, fill in the form: dropdowns are pre-filled with the values already used across the wiki, and the '''Has Document''' field on the Reference form lets you search for the document you're referencing instead of typing its exact title.
# Save. A Document page automatically lists every Reference that links to it — you don't need to add it anywhere else.


=== Editing an existing page ===
; [[Help:Document pages|Document: pages]]
: Represent source documents — regulatory texts, guidelines, legal acts. Each Document page contains a structured infobox (Document Information) with metadata, and a table of all linked Reference pages. Identified by their reference code, e.g. <code>Document:ICH ICH E6 Guideline R3 (2025)</code>.


# Open the page.
; [[Help:Reference pages|Reference: pages]]
# Click '''Edit'''. Document: and Reference: pages open the form with the same fields you used to create them; other pages open the normal wikitext editor.
: Represent individual text passages or excerpts from a Document. Each Reference page is linked to exactly one Document page. The Document infobox is shown automatically via transclusion. The Reference Details infobox shows scope, language, module/unit and tags. The original text appears under <code>== Content ==</code>.
# If you specifically need the raw wikitext of a Document or Reference page (rare), use '''Edit source''' instead.
# Make your changes and save.


=== Finding content ===
; [[Glossary|Glossary: pages]]
: One page per keyword (TAG-ID, e.g. <code>Glossary:TAG-00001-Med-rzn</code>). Each glossary page shows translations in EN/FR/DE and a live list of all Reference pages using this keyword.
 
; Regular wiki pages
: Free-form pages for navigation, documentation or project information. Examples: [[Glossary]], [[Table of Content]], [[GxPlex:New page]].
 
=== Namespaces ===


{| class="wikitable"
{| class="wikitable"
! Page !! What it's for
! Namespace !! Prefix !! Purpose
|-
|-
| [[GxPlex_Search|Search in GxPlex]] || Full-text and filtered search across documents and references.
| Document: || <code>Document:</code> || Source document catalog
|-
|-
| [[Document_Index|All documents]] || Browsable, filterable list of every Document page, grouped by status and scope.
| Reference: || <code>Reference:</code> || Text passages and excerpts
|-
|-
| [[Special:Categories|Keywords / Tags]] || Browse by category.
| Glossary: || <code>Glossary:</code> || Keyword definitions (TAG-IDs)
|-
|-
| [[Themes_and_topics|Themes and topics]] || Curated topic overview pages.
| (Main) || (none) || Navigation, help, project pages
|-
|-
| [[Glossary|Glossary]] || Definitions for terms and abbreviations used across references.
| Template: || <code>Template:</code> || Reusable components (DocumentBox, ReferenceData etc.)
|}
|}


=== Approval workflow ===
=== Creating new pages ===
 
Use [[GxPlex:New page]] to create a new Document or Reference page using the built-in form. Fields have dropdowns where applicable (Scope, Language, Status, Document type).
 
==== New Reference page ====
 
# Go to [[GxPlex:New page]] → ''Neue Referenz-Seite erstellen''
# Enter the page name — format: <code>Reference:&lt;document-reference&gt; &lt;document-part&gt;</code>
## Example: <code>Reference:ICH ICH E6 Guideline R3 (2025) Appendix B.4</code>
# Fill in the fields:
#* '''Has Document''' — link to the Document: page (autocomplete)
#* '''Module / Unit''' — from the [[Table of Content]] (e.g. Module 1, Unit 1.1.1)
#* '''Scope''' — dropdown: G, HM, MD, IVD, NIS, INS, Other
#* '''Document part''' — section, article or paragraph reference
#* '''Language''' — language of the original text
#* '''Tags''' — TAG-IDs from the [[Glossary]], separated by <code>++</code><br/>Example: <code>TAG-00001-Med-rzn ++ TAG-00003-Adv-cht</code>
#* '''Content''' — the original text passage
# Save
 
==== New Document page ====
 
# Go to [[GxPlex:New page]] → ''Neue Dokument-Seite erstellen''
# Enter the page name — format: <code>Document:&lt;reference-code&gt;</code>
# Fill in metadata: reference, validity area, scope, document name, version, status, document type, language, description, official link, restricted access
# Save
 
=== Editing existing pages ===
 
Click '''Edit''' on any Document or Reference page — the form opens with all current values pre-filled. After saving, an administrator must approve the revision before it becomes publicly visible (see [[Special:ApprovedRevs]]).
 
=== Tags and the Glossary ===
 
Tags connect Reference pages to keywords in the [[Glossary]].
 
# Look up the correct TAG-ID in [[Glossary]]
# Copy the TAG-ID into the Tags field (e.g. <code>TAG-00001-Med-rzn</code>)
# Separate multiple tags with <code> ++ </code>
# '''New tag not in the Glossary?''' A notice appears when editing a Reference page reminding you to check. Add the new entry to the <code>Glossary-Keywords</code> sheet in the Excel source file and notify an administrator — or create the <code>Glossary:TAG-XXXXX-...</code> page manually following the existing format.
 
=== Wikitext markup quick reference ===


New and edited pages aren't visible to the public, or to other users, until a reviewer approves
{| class="wikitable"
them. You can keep working on your own unapproved pages in the meantime — only you, reviewers,
! Element !! Markup !! Example
and administrators can see them until then.
|-
| Section heading || <code>== Heading ==</code> || == My Section ==
|-
| Internal link || <code><nowiki>[[Page name]]</nowiki></code> || <nowiki>[[Glossary]]</nowiki>
|-
| Link with label || <code><nowiki>[[Page name|Label]]</nowiki></code> || <nowiki>[[Glossary|Keywords]]</nowiki>
|-
| Bold || <code><nowiki>'''text'''</nowiki></code> || '''bold'''
|-
| Italic || <code><nowiki>''text''</nowiki></code> || ''italic''
|-
| Wikitable || <code>{&#124; class="wikitable"</code> ... <code>&#124;}</code> || see this table
|-
| SMW store || <code><nowiki>{{#set:|Property=Value}}</nowiki></code> || stores semantic data silently
|-
| SMW query || <code><nowiki>{{#ask:[[Property::Value]]|format=table}}</nowiki></code> || dynamic result list
|-
| Transclusion || <code><nowiki>{{:Page name}}</nowiki></code> || embeds full content of another page
|-
| Code || <code>&lt;code&gt;text&lt;/code&gt;</code> || <code>inline code</code>
|}


=== Roles ===
=== Extensions ===


{| class="wikitable"
{| class="wikitable"
! Role !! Permissions
! Extension !! Purpose
|-
| [[mw:Extension:SemanticMediaWiki|SemanticMediaWiki]] || Structured data storage and queries (<code>{{#set:}}</code>, <code>{{#ask:}}</code>)
|-
| [[mw:Extension:PageForms|PageForms]] || Form-based page creation and editing with dropdowns
|-
| [[mw:Extension:ApprovedRevs|ApprovedRevs]] || Revision approval before public visibility
|-
| [[mw:Extension:VoteNY|VoteNY]] || Star rating on pages
|-
|-
| Author || Create and edit pages
| [[mw:Extension:InputBox|InputBox]] || Search input on wiki pages
|-
|-
| Reviewer || Approve or reject submitted pages
| [[mw:Extension:ParserFunctions|ParserFunctions]] || Logic in templates (<code>{{#if:}}</code>, <code>{{#switch:}}</code>)
|-
|-
| Administrator || Full access including user management
| [[mw:Extension:CategoryTree|CategoryTree]] || Collapsible category trees
|}
|}


=== Questions? ===
=== Editing the sidebar menu ===
 
The menu on the left is a regular wiki page, not code. You don't need any programming knowledge to change it.
 
# Log in with an administrator account.
# Go to '''MediaWiki:Sidebar''' and click '''Edit'''.
# Each line follows one of two patterns:
#* A single <code>*</code> starts a bold section heading, for example <code>* Navigation</code>.
#* A double <code>**</code> adds a link under that heading, in the format <code>PageName|Text shown to visitors</code>.
# To add a new menu item, add a new <code>**</code> line under the section it belongs to. To remove one, delete its line.
# Save. The change is visible immediately, no approval step required.
 
'''Example''' (an excerpt of the current menu):
<pre>
* Navigation
** GxPlex_Search|Search in GxPlex
** Contact|Contact us
</pre>


Contact the wiki administrator or visit [[About_GxPlex|About GxPlex]].
Leave the <code>* TOOLBOX</code> line as it is: it inserts MediaWiki's built-in tools and isn't meant to be edited by hand.

Latest revision as of 18:42, 19 July 2026

How to Contribute

This page explains how GxPlex is structured and how to add or edit content.

Wiki structure

GxPlex uses four types of pages:

Document: pages
Represent source documents — regulatory texts, guidelines, legal acts. Each Document page contains a structured infobox (Document Information) with metadata, and a table of all linked Reference pages. Identified by their reference code, e.g. Document:ICH ICH E6 Guideline R3 (2025).
Reference: pages
Represent individual text passages or excerpts from a Document. Each Reference page is linked to exactly one Document page. The Document infobox is shown automatically via transclusion. The Reference Details infobox shows scope, language, module/unit and tags. The original text appears under == Content ==.
Glossary: pages
One page per keyword (TAG-ID, e.g. Glossary:TAG-00001-Med-rzn). Each glossary page shows translations in EN/FR/DE and a live list of all Reference pages using this keyword.
Regular wiki pages
Free-form pages for navigation, documentation or project information. Examples: Glossary, Table of Content, GxPlex:New page.

Namespaces

Namespace Prefix Purpose
Document: Document: Source document catalog
Reference: Reference: Text passages and excerpts
Glossary: Glossary: Keyword definitions (TAG-IDs)
(Main) (none) Navigation, help, project pages
Template: Template: Reusable components (DocumentBox, ReferenceData etc.)

Creating new pages

Use GxPlex:New page to create a new Document or Reference page using the built-in form. Fields have dropdowns where applicable (Scope, Language, Status, Document type).

New Reference page

  1. Go to GxPlex:New page → Neue Referenz-Seite erstellen
  2. Enter the page name — format: Reference:<document-reference> <document-part>
    1. Example: Reference:ICH ICH E6 Guideline R3 (2025) Appendix B.4
  3. Fill in the fields:
    • Has Document — link to the Document: page (autocomplete)
    • Module / Unit — from the Table of Content (e.g. Module 1, Unit 1.1.1)
    • Scope — dropdown: G, HM, MD, IVD, NIS, INS, Other
    • Document part — section, article or paragraph reference
    • Language — language of the original text
    • Tags — TAG-IDs from the Glossary, separated by ++
      Example: TAG-00001-Med-rzn ++ TAG-00003-Adv-cht
    • Content — the original text passage
  4. Save

New Document page

  1. Go to GxPlex:New page → Neue Dokument-Seite erstellen
  2. Enter the page name — format: Document:<reference-code>
  3. Fill in metadata: reference, validity area, scope, document name, version, status, document type, language, description, official link, restricted access
  4. Save

Editing existing pages

Click Edit on any Document or Reference page — the form opens with all current values pre-filled. After saving, an administrator must approve the revision before it becomes publicly visible (see Special:ApprovedRevs).

Tags and the Glossary

Tags connect Reference pages to keywords in the Glossary.

  1. Look up the correct TAG-ID in Glossary
  2. Copy the TAG-ID into the Tags field (e.g. TAG-00001-Med-rzn)
  3. Separate multiple tags with ++
  4. New tag not in the Glossary? A notice appears when editing a Reference page reminding you to check. Add the new entry to the Glossary-Keywords sheet in the Excel source file and notify an administrator — or create the Glossary:TAG-XXXXX-... page manually following the existing format.

Wikitext markup quick reference

Element Markup Example
Section heading == Heading == == My Section ==
Internal link [[Page name]] [[Glossary]]
Link with label [[Page name|Label]] [[Glossary|Keywords]]
Bold '''text''' bold
Italic ''text'' italic
Wikitable class="wikitable" ... |} see this table
SMW store {{#set:|Property=Value}} stores semantic data silently
SMW query {{#ask:[[Property::Value]]|format=table}} dynamic result list
Transclusion {{:Page name}} embeds full content of another page
Code <code>text</code> inline code

Extensions

Extension Purpose
SemanticMediaWiki Structured data storage and queries (, The query description has an empty condition.)
PageForms Form-based page creation and editing with dropdowns
ApprovedRevs Revision approval before public visibility
VoteNY Star rating on pages
InputBox Search input on wiki pages
ParserFunctions Logic in templates (, )
CategoryTree Collapsible category trees

Editing the sidebar menu

The menu on the left is a regular wiki page, not code. You don't need any programming knowledge to change it.

  1. Log in with an administrator account.
  2. Go to MediaWiki:Sidebar and click Edit.
  3. Each line follows one of two patterns:
    • A single * starts a bold section heading, for example * Navigation.
    • A double ** adds a link under that heading, in the format PageName|Text shown to visitors.
  4. To add a new menu item, add a new ** line under the section it belongs to. To remove one, delete its line.
  5. Save. The change is visible immediately, no approval step required.

Example (an excerpt of the current menu): 

* Navigation
** GxPlex_Search|Search in GxPlex
** Contact|Contact us

Leave the * TOOLBOX line as it is: it inserts MediaWiki's built-in tools and isn't meant to be edited by hand.

Rate this page
0.00
(0 votes)
Retrieved from "https://gxplex.org/index.php?title=Contribute_to_GxPlex&oldid=20476"