Jump to content

Research:Workflow: Difference between revisions

From Costa Sano MediaWiki
Research workflow for club members
 
No edit summary
 
Line 1: Line 1:
= Operational Workflows =
= Operational Workflows for club members =


This page describes how data, pages, and media are created, edited, and published. It focusses on practical day-to-day workflows.
This page describes how data, pages, and media are created, edited, and published. It focusses on practical day-to-day workflows.


== Workflow for clubmembers ==
== General Workflow Principle ==
 
=== General Workflow Principle ===
Work proceeds in phases:
Work proceeds in phases:


Line 15: Line 13:
Public output must be stable and curated.
Public output must be stable and curated.


=== Public Publication Workflow ===
== Public Publication Workflow ==
Publication is a deliberate act for club members only.
Publication is a deliberate act for club members only.


Line 23: Line 21:
# Create or select a public file derivative in the Research: namespace which is not public
# Create or select a public file derivative in the Research: namespace which is not public
# Verify that no internal files are referenced
# Verify that no internal files are referenced
# Once reviewed and redy for publication, the page is copied to the MAIN: namespace and as such available to the general public
# Once reviewed and ready for publication, the page is copied to the MAIN: namespace and as such available to the general public
# A review version of the document remains in Research: namespace.
# A review version of the document remains in Research: namespace.


=== Research: namespace - prepare publication and home for user guides ===
== Research: namespace - prepare publication and home for user guides ==
The Research: namespace is accessible for all clubmembers and is the host for  
The Research: namespace is accessible for all club members and is the host for  


# Documents explaining the workflow procedures in laymans terms
# Documents explaining the workflow procedures in laymans terms
# The environment for preparing documents for the general public.
# The environment for preparing documents for the general public.
# Different Categories are used for these 2 types of documents.
# Categories is a MediaWiki concept and helps organising pages.


=== Dashboard: namespace -  Adding and editing objects workflow ===
== Dashboard: namespace -  Adding and editing objects workflow ==
Access and editing objects in the project go through the dashboard. a Dashboard: namespace i intended for this workflow
Access and editing objects in the project go through the dashboard. A Dashboard: namespace i intended for this workflow


# There is an overview Dashboard; page.
# There is an overview Dashboard; page.
# Each entity in its particular namespace has a dashboard page
# Each entity in its particular namespace has a dashboard page sucn.
# Example Dashboard:Heritage
# The Dashboard: namespace is reserved for club members only.


=== (Main): namespace ===
== (Main): namespace ==
The (Main) namespace is the default one and does not need to be mentioned. All pages without explicit namespace mentioned in front are in the (Main) namespace and PUBLIC.
The (Main) namespace is the default one and does not need to be mentioned. All pages without explicit namespace mentioned in front are in the (Main) namespace and PUBLIC.


# The public namespace has a  home page for the website which is the landing page for https://mwiki.costasana.club
# The public namespace has a  home page for the website which is the landing page for https://mwiki.costasana.club
# This public space is reserved for documents created in the Research: namespace  and are after review approved by the club members for public publication.
# This public space is reserved for documents created in the Research: namespace  and are after review approved by the club members for public publication.
# If decided by the club membsers, these pages may also be copied to Wikipedia.
# If decided by the club members, these pages may also be copied to Wikipedia.


=== Creating Structured Pages describing research objects ===
== Creating Structured Pages describing research objects ==
 
=== Digital Assets (Asset:) ===
The research project is fundamentally based on the collection of mediaobject that are used to understand the historical research environment. The are called DigitalAssets. DigitalAssets are a sort of historical metadata about a particular digital media object (file).
 
Steps:
 
# Create an Asset: page using Dashboard:Asset
# ONE Asset goes with ONE media file
# Select elements for automatic numbering.
# Upload a filen. Filename is automatic and is based on the automatic name for the Asset.
# Link the Asset to one or more Heritage: pages
# Optionally define parent/child relationships between related Assets and its media files
# Optionally define the DigitalAsset as child of one or more HeritageObjects. This can be done during the creation of the DigitalAsset if the HeritageObject already exist, or can be done in a later stage as an editing action via the Dashboard:Asset page.
 
=== Heritage Objects (Heritage:) ===
DigitalAssets are considered in the framework of a historical object under study called HeritageObject.


==== Heritage Objects (Heritage:) ====
Steps:
Steps:


# Use the HeritageObject dashboard to access the form
# Use the HeritageObject dashboard to access the form
# Dashboard acces is  Dashboard:Heritage
# Dashboard acces is  Dashboard:Heritage
# Enter required metadata
# Enter required metadata for the object
# Select elements for automatic numbering
# Select elements for automatic numbering
# Save the page
# Save the page
# Review stored data via the dashboard
# Review stored data via the dashboard
# Although DigitalAssets are a cental point of collecting mediaobject proving something, they are only usefull in the framework of one or more HeritageObjects


Editing of Heritage: pages goes through the dashboard. Heritage: pages are for internal viewing.
Editing of Heritage: pages goes through the dashboard. Heritage: pages are for internal viewing.


=== Digital Assets (Asset:) ===
#
 
Steps:
 
# Create an Asset: page using Dashboard:Asset
# ONE Asset goes with ONE media file
# Select elements for automatic numbering.
# Upload a filen. Filename is automatic and is based on the automatic name for the Asset.
# Link the Asset to one or more Heritage: pages
# Optionally define parent/child relationships between related Assets and its media files


=== Other Entities ===
=== Other Entities ===
Line 76: Line 85:
# Access only via a dashboard
# Access only via a dashboard
# Dashboards exist for Person, Place, Organizatin, Keywords etc..
# Dashboards exist for Person, Place, Organizatin, Keywords etc..
== Workflow for SYSOP ==
=== Managing Relationships ===
Many-to-many relationships are handled using:
* Cargo subtables
* Repeatable form sections
* Only accessible by the sysop
Examples:
* Object–Person relationships
* Object–Set memberships
Relationships are always edited in the context of a parent page.
=== Schema Evolution Workflow ===
Changes to structure follow this order:
# This workflow is reserved to the sysop or administrator
# Update Cargo table
# Save Cargo page to activate changes
# Update forms, special templates and dashboard if required
# Test with sample data
Never change schema directly in the database.
=== Error Handling ===
If data does not appear as expected:
# Check Cargo table definition
# Check that the Cargo page was saved
# Check form-to-field mapping
# Check namespace and category constraints


== Status ==
== Status ==


This workflow is considered stable but may evolve.
This workflow is considered stable but may evolve. revision 2026/02/09

Latest revision as of 11:13, 9 February 2026

Operational Workflows for club members

This page describes how data, pages, and media are created, edited, and published. It focusses on practical day-to-day workflows.

General Workflow Principle

Work proceeds in phases:

  1. Internal research and structuring
  2. Review and validation
  3. Public publication

Internal work may be complex and incomplete. Public output must be stable and curated.

Public Publication Workflow

Publication is a deliberate act for club members only.

Typical steps:

  1. Identify content ready for publication
  2. Create or select a public file derivative in the Research: namespace which is not public
  3. Verify that no internal files are referenced
  4. Once reviewed and ready for publication, the page is copied to the MAIN: namespace and as such available to the general public
  5. A review version of the document remains in Research: namespace.

Research: namespace - prepare publication and home for user guides

The Research: namespace is accessible for all club members and is the host for

  1. Documents explaining the workflow procedures in laymans terms
  2. The environment for preparing documents for the general public.
  3. Different Categories are used for these 2 types of documents.
  4. Categories is a MediaWiki concept and helps organising pages.

Dashboard: namespace - Adding and editing objects workflow

Access and editing objects in the project go through the dashboard. A Dashboard: namespace i intended for this workflow

  1. There is an overview Dashboard; page.
  2. Each entity in its particular namespace has a dashboard page sucn.
  3. Example Dashboard:Heritage
  4. The Dashboard: namespace is reserved for club members only.

(Main): namespace

The (Main) namespace is the default one and does not need to be mentioned. All pages without explicit namespace mentioned in front are in the (Main) namespace and PUBLIC.

  1. The public namespace has a home page for the website which is the landing page for https://mwiki.costasana.club
  2. This public space is reserved for documents created in the Research: namespace and are after review approved by the club members for public publication.
  3. If decided by the club members, these pages may also be copied to Wikipedia.

Creating Structured Pages describing research objects

Digital Assets (Asset:)

The research project is fundamentally based on the collection of mediaobject that are used to understand the historical research environment. The are called DigitalAssets. DigitalAssets are a sort of historical metadata about a particular digital media object (file).

Steps:

  1. Create an Asset: page using Dashboard:Asset
  2. ONE Asset goes with ONE media file
  3. Select elements for automatic numbering.
  4. Upload a filen. Filename is automatic and is based on the automatic name for the Asset.
  5. Link the Asset to one or more Heritage: pages
  6. Optionally define parent/child relationships between related Assets and its media files
  7. Optionally define the DigitalAsset as child of one or more HeritageObjects. This can be done during the creation of the DigitalAsset if the HeritageObject already exist, or can be done in a later stage as an editing action via the Dashboard:Asset page.

Heritage Objects (Heritage:)

DigitalAssets are considered in the framework of a historical object under study called HeritageObject.

Steps:

  1. Use the HeritageObject dashboard to access the form
  2. Dashboard acces is Dashboard:Heritage
  3. Enter required metadata for the object
  4. Select elements for automatic numbering
  5. Save the page
  6. Review stored data via the dashboard
  7. Although DigitalAssets are a cental point of collecting mediaobject proving something, they are only usefull in the framework of one or more HeritageObjects

Editing of Heritage: pages goes through the dashboard. Heritage: pages are for internal viewing.

Other Entities

Steps:

  1. Similar as for Heritage Objects and DigitalAssets
  2. Access only via a dashboard
  3. Dashboards exist for Person, Place, Organizatin, Keywords etc..

Status

This workflow is considered stable but may evolve. revision 2026/02/09