Difference between revisions of "Main Page"

From City Data Model Project Collaboratory
Jump to navigation Jump to search
Line 26: Line 26:
  
 
start
 
start
:create proposal;
+
:Specify the name of the new class or property;
  
:suggest appropriate ontology;
+
:Provide a natural language description of new term;
    if (new ontology?) then (yes)
 
        :Propose New Ontology;
 
    else(no)
 
    endif;
 
:specify description;
 
 
 
:specify definition (UML or DL);
 
  
:specify use case(s);
+
:New term page created
 +
Term status="proposal";
  
:publish for review;
+
:Community review;
:users review proposal;
 
  
if (requirement is met by an existing class or property?) then (yes)
+
if (Term is captured by an existing class or property?) then (yes)
 
     :indicate redundancy in comments;
 
     :indicate redundancy in comments;
     if (community in agreement?) then (yes)
+
     if (community in agreement?) then (Yes)
         :close proposal;
+
         :Close proposal
 +
        Term status="closed";
 
         stop
 
         stop
     else(no)
+
     else(No)
         while (undecided) is (yes)
+
         while (undecided) is (Yes)
             :discuss;
+
             :Discuss;
             :editorial review;
+
             :Editorial review;
         endwhile(no);
+
         endwhile(No);
 
     endif;
 
     endif;
     else(no)
+
     else(No)
 
     endif;
 
     endif;
         :users propose revisions/additions to definition (properties, constraints), motivating scenarios;
+
         :Term status="In Progress";     
 +
        while (Discussion quiescence (or other cutoff criteria)?) is (No)
 +
                :Community proposes definitions;
 +
            endwhile(Yes)
 +
                :Admin specify maximum common definition;
 +
                :Term status="Approved";
 +
        :Publication of final version of term page (change protected),
 +
        including maximum common definition and specialized definitions;
 +
stop
 +
 
 +
@enduml
 +
</uml>
 +
 
 +
<uml>
 +
@startuml
 +
title Submitting a definition for a proposed term
 +
 
 +
start
 +
:Navigate to proposed term page;
 +
:Select "Add Definition;
 +
:Specify description
 +
What distinguishes this definition of the term?;
 +
 
 +
:Specify use case(s)
 +
Why is this specialized definition needed?;
 +
 
 +
:Specify definition in UML and DL
 +
If DL is not sufficient, supplement with SWRL or SHACL;
 +
 
 +
:Publish for review;
 +
 
 +
:Community reviews proposal;
 +
 
 +
:Users suggest revisions/additions to definition (properties, constraints), use cases;
 
          
 
          
            if (owner revise?) then (yes)
+
if (Owner accommodates suggestions?) then (Yes)
                :comment resolved;
+
  :Comment resolved;
            else(no)
+
else(No)
                :comment left unresolved;
+
  :Comment left unresolved;
            endif;
+
endif;
 
      
 
      
        :editorial review;
+
:Editorial review;
         :editorial comments to author;
+
         :Editorial comments to author;
         :author revisions;
+
         :Author revisions;
         :final review;
+
         :Final review;
         :publication of final version (change protected);
+
         :Specialized definition marked as approved (change protected);
  
 
stop
 
stop
Line 74: Line 101:
 
</uml>
 
</uml>
  
<b>Note:</b> this diagram was drawn using [http://plantuml.com PlantUML]. PlantUML is a handy tool that allows you to create UML (and non-UML) diagrams using simple text descriptions. It's supported by this Wiki to help you contribute more effectively.
+
<b>Note:</b> these diagrams were drawn using [http://plantuml.com PlantUML]. PlantUML is a handy tool that allows you to create UML (and non-UML) diagrams using simple text descriptions. It's supported by this Wiki to help you contribute more effectively.
  
 
== To Do ==
 
== To Do ==

Revision as of 21:53, 22 October 2019

Welcome to the City Data Model Collaboration Wiki!

We have created this website to enable stakeholders and related standards groups to:

  • Review the contents of the City Data Model.
  • Propose new classes or properties
  • Comment on existing classes
  • Comment on proposed classes
  • Suggest changes and additions

How it works

Anyone with an account can comment on proposed or existing terms, and even propose their own.

Getting started

Want to contribute? Log-in or create an account!

See something missing?

Propose a new class:


How it works

Anyone can propose a new term. Once a term has been proposed, it becomes open for the specification of definitions from the community. The administrators will review all proposed definitions and identify the maximal common definition for the term. The term and resulting set of definitions will then be published as approved in the City Data Model.

Here's a high-level overview of the process that we follow when a new term is proposed for the City Data Model:

<uml> @startuml title Proposing a New Term for the CDM

start

Specify the name of the new class or property;
Provide a natural language description of new term;
New term page created

Term status="proposal";

Community review;

if (Term is captured by an existing class or property?) then (yes)

   :indicate redundancy in comments;
   if (community in agreement?) then (Yes)
       :Close proposal
        Term status="closed";
       stop
   else(No)
       while (undecided) is (Yes)
           :Discuss;
           :Editorial review;
       endwhile(No);
   endif;
   else(No)
   endif;
       :Term status="In Progress";       
       while (Discussion quiescence (or other cutoff criteria)?) is (No)
               :Community proposes definitions;
           endwhile(Yes)
               :Admin specify maximum common definition;
               :Term status="Approved";
       :Publication of final version of term page (change protected),
       including maximum common definition and specialized definitions;

stop

@enduml </uml>

<uml> @startuml title Submitting a definition for a proposed term

start

Navigate to proposed term page;
Select "Add Definition;
Specify description

What distinguishes this definition of the term?;

Specify use case(s)

Why is this specialized definition needed?;

Specify definition in UML and DL

If DL is not sufficient, supplement with SWRL or SHACL;

Publish for review;
Community reviews proposal;
Users suggest revisions/additions to definition (properties, constraints), use cases;

if (Owner accommodates suggestions?) then (Yes)

  :Comment resolved;

else(No)

  :Comment left unresolved;

endif;

Editorial review;
       :Editorial comments to author;
       :Author revisions;
       :Final review;
       :Specialized definition marked as approved (change protected);

stop

@enduml </uml>

Note: these diagrams were drawn using PlantUML. PlantUML is a handy tool that allows you to create UML (and non-UML) diagrams using simple text descriptions. It's supported by this Wiki to help you contribute more effectively.

To Do

Link to Github
Link to publications (reports, papers, ...)
Add summary of classes / class definitions for each city-level ontology
Set permissions for different user types