Jump to content

ICT:Workflow: Difference between revisions

From Costa Sano MediaWiki
192.168.33.222 (talk)
VisualWikitext
Created page with "= Operational Workflow = This page describes how data, pages, and media are created, edited, and published. It focuses on practical day-to-day workflows. == General Workflow Principle == Work proceeds in phases: # Internal research and structuring # Review and validation # Public publication Internal work may be complex and incomplete. Public output must be stable and curated. == Creating Structured Pages == === Heritage Objects (HO:) === Steps: # Use the Herit..."
 
Serious revision due to latest design decisions
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
= Operational Workflow =
= Operational Workflows =


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


It focuses on practical day-to-day workflows.
== Workflow for clubmembers ==
 
== General Workflow Principle ==


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


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


== Creating Structured Pages ==
=== Public Publication Workflow ===
Publication is a deliberate act for club members only.
 
Typical steps:
 
# Identify content ready for publication
# Create or select a public file derivative in the Research: namespace which is not public
# 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
# 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 clubmembers and is the host for
 
# Documents explaining the workflow procedures in laymans terms
# The environment for preparing documents for the general public.
 
=== 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
 
# There is an overview Dashboard; page.
# Each entity in its particular namespace has a dashboard page


=== Heritage Objects (HO:) ===
=== (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 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.
# If decided by the club membsers, these pages may also be copied to Wikipedia.
=== Creating Structured Pages describing research objects ===
==== Heritage Objects (Heritage:) ====
Steps:
Steps:


# Use the HeritageObject form
# Use the HeritageObject dashboard to access the form
# Dashboard acces is  Dashboard:Heritage
# Enter required metadata
# Enter required metadata
# Select elements for automatic numbering
# Save the page
# Save the page
# Review stored data via queries if needed
# Review stored data via the dashboard


Direct editing of HO pages without forms is discouraged.
Editing of Heritage: pages goes through the dashboard. Heritage: pages are for internal viewing.


=== Digital Assets (DA:) ===
=== Digital Assets (Asset:) ===


Steps:
Steps:


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


DA pages are internal and not intended for public viewing.
=== Other Entities ===
Steps:


== Managing Relationships ==
# Similar as for Heritage Objects and DigitalAssets
# Access only via a dashboard
# Dashboards exist for Person, Place, Organizatin, Keywords etc..


== Workflow for SYSOP ==
=== Managing Relationships ===
Many-to-many relationships are handled using:
Many-to-many relationships are handled using:


* Cargo subtables
* Cargo subtables
* Repeatable form sections
* Repeatable form sections
* Only accessible by the sysop


Examples:
Examples:
Line 54: Line 92:
Relationships are always edited in the context of a parent page.
Relationships are always edited in the context of a parent page.


== File Upload Workflow ==
=== Schema Evolution Workflow ===
 
# Upload file to File: namespace
# Verify file name and format
# Add file reference to a DA page
# Do not embed internal files on public pages
 
File uploads are restricted to club members.
 
== Public Publication Workflow ==
 
Publication is a deliberate act.
 
Typical steps:
 
# Identify content ready for publication
# Create or select a public file derivative
# Embed the public file on a page in the Main namespace
# Verify that no internal files are referenced
 
Internal DA pages remain private.
 
== Schema Evolution Workflow ==
 
Changes to structure follow this order:
Changes to structure follow this order:


# This workflow is reserved to the sysop or administrator
# Update Cargo table
# Update Cargo table
# Save Cargo page to activate changes
# Save Cargo page to activate changes
# Update Page Schema if needed
# Update forms, special templates and dashboard if required
# Regenerate forms if required
# Test with sample data
# Test with sample data


Never change schema directly in the database.
Never change schema directly in the database.


== Error Handling ==
=== Error Handling ===
 
If data does not appear as expected:
If data does not appear as expected:


Latest revision as of 10:52, 9 February 2026

Operational 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

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 redy 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 clubmembers and is the host for

  1. Documents explaining the workflow procedures in laymans terms
  2. The environment for preparing documents for the general public.

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

(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 membsers, these pages may also be copied to Wikipedia.

Creating Structured Pages describing research objects

Heritage Objects (Heritage:)

Steps:

  1. Use the HeritageObject dashboard to access the form
  2. Dashboard acces is Dashboard:Heritage
  3. Enter required metadata
  4. Select elements for automatic numbering
  5. Save the page
  6. Review stored data via the dashboard

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

Digital Assets (Asset:)

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

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..

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:

  1. This workflow is reserved to the sysop or administrator
  2. Update Cargo table
  3. Save Cargo page to activate changes
  4. Update forms, special templates and dashboard if required
  5. Test with sample data

Never change schema directly in the database.

Error Handling

If data does not appear as expected:

  1. Check Cargo table definition
  2. Check that the Cargo page was saved
  3. Check form-to-field mapping
  4. Check namespace and category constraints

Status

This workflow is considered stable but may evolve.

Retrieved from "https://mwiki.costasano.club/index.php?title=ICT:Workflow&oldid=511"