ART Project Editor - Revision history

Admin at 12:24, 28 July 2021

2021-07-28T12:24:05Z

Admin at 12:23, 28 July 2021

2021-07-28T12:23:38Z

Admin at 10:20, 28 July 2021

2021-07-28T10:20:55Z

Admin: /* Marking a project as Experimental */

2021-03-16T12:21:09Z

‎Marking a project as Experimental

Admin: /* Preflighting publication and quality checks */

2021-03-16T11:45:24Z

‎Preflighting publication and quality checks

Admin: /* Add a language to a project */

2021-03-16T11:44:55Z

‎Add a language to a project

Admin: /* Add a language to a project */

2021-03-16T11:44:37Z

‎Add a language to a project

Admin: /* Changing the name of a project */

2021-03-16T11:44:16Z

‎Changing the name of a project

Admin: /* Reference a building block repository */

2021-03-16T11:43:56Z

‎Reference a building block repository

Admin: /* Project Index */

2021-03-16T11:43:41Z

‎Project Index

@@ Line 34: / Line 34: @@
 Select the added language in the top-right:
 [[File:En_language_add_05.jpg|750px]]
 The project name should now be shown in English.
 [[File:En_language_add_06.jpg|500px]]

@@ Line 2: / Line 2: @@
 =Changing the name of a project=
 Edit the name for the project.
 [[File:En_language_add_01.jpg|750px]]
@@ Line 13: / Line 14: @@
 Edit the name for the project.
 [[File:En_language_add_01.jpg|750px]]
@@ Line 24: / Line 26: @@
 To save, click on the button: '''Change'''
 [[File:En_language_add_03.jpg|500px]]
@@ Line 66: / Line 69: @@
 * Go to tab '''Project/General'''
 * Click on '''Contains reusable content?'''
 [[File:mark_repository.png|750px]]
@@ Line 89: / Line 93: @@
 The Project Index can be accessed by clicking on the link:
 [[File:Projectindex.png|450px]]
 Screenshot of the Project index of an example project:
 [[File:Projectindex_en_demo1.png|750px]]
@@ Line 103: / Line 109: @@
 * Click '''add''' to add a BBR-reference in the current project
 Screenshot that shows the user-interface for adding a BBR-reference from a project:
 [[File:En_project_bbr_reference.png|750px]]
 * Click '''Save''' to update the project information
 * After saving the project information, the BBR-reference is shown like:
 [[File:En_project_bbr_reference_added.png|750px]]
 * After adding the BBR-reference: when adding dataset concepts, value sets or templates, content from the BBR is also presented in the current project
@@ Line 140: / Line 150: @@
 * Log in as '''decor-admin'''
 * Go to the page 'Project/Development'
 [[File:en_development_check_01.png|350px|Click Development page]]
 * Make sure the correct dataset is selected
 [[File:en_development_check_02.png|350px|Select dataset]]
 * Click the button to Check DECOR
 [[File:en_development_check_03.png|350px|Click Check DECOR]]
@@ Line 163: / Line 178: @@
 Start the compilation process:
 [[File:Development_version_02.png|550px|Compile a development version: compiling]]
 After compiling you can validate XML instances from your desktop against the compiled schematron:
 [[File:Development_version_03.png|950px|Validate XML instance]]
@@ Line 174: / Line 191: @@
 * Log in as '''decor-admin'''
 * Check that ADRAM is configured for this project. On the tab 'Project/General', Publication location should contain a URL where the publication is going to be published. Behind the 'Publication location' it should show 'Release and Archive Manager configured' (this checks that ADRAM is configured for this project at the publication location).
 [[File:En project publication 01.jpg|750px|normal user view]]
 On the tab 'Project/Version information', one can create a new version/release/publication request by clicking on the plus button (see 1 at figure below). In addition the publication parameters and filter can be set by clicking on the wheel button (2). Finally you may compare two releases of your project by clicking on the delta button (3).
 [[File:Projectpublication02.png|750px|normal user view]]
@@ Line 185: / Line 204: @@
 * Publication request: selecting this checkbox will trigger ADRAM to create a publication at the publication location shown.
 * Select 'Add' to confirm.
 [[File:En project publication 03.jpg|750px|normal user view]]
@@ Line 192: / Line 212: @@
 ===General tab===
 [[File:Projectpublication10.png|550px|normal user view]]
 ===ISO schematron generation tab===
 [[File:Publication_parameters_01.png|550px|normal user view]]
 ===Human readable publication tab===
 In the ''Human readable publication'' tab there is also a small lists of artefact categories to be chosen from to determine whether they are included in a resulting PDF or not (1).
 [[File:Projectpublication11.png|550px|normal user view]]
 ===Filter tab===
 The Publication ''Filter'' tab allows to set filters on and off, i.e. whether a publication contains all scenarios/transactions of the project (filter "off", see 1) or only selected ones. You can select either one or multiple scenarios/transactions from your project's scenarios/transactions in the list (2). You must give a label to your filter in order to describe the nature of the partial publication (3). The "Select all" and "Clear selection" button allows you to select all or none of the scenarios/transactions (4).
 [[File:Projectpublication12.png|550px|normal user view]]
@@ Line 215: / Line 239: @@
 *'''Build failed''': This special status represents that during the build and compile phase of the publication, ADRAM detected a processing error.
 [[File:En project publication 05.jpg|750px|normal user view]]
 ADRAM will re-check and update the publication status at the publication location. Visit the publication location URL to see the various releases:
 [[File:En project publication 04.jpg|750px|normal user view]]

@@ Line 2: / Line 2: @@
 =Changing the name of a project=
 Edit the name for the project.
 [[File:En_language_add_01.jpg|750px]]
@@ Line 14: / Line 13: @@
 Edit the name for the project.
 [[File:En_language_add_01.jpg|750px]]
@@ Line 26: / Line 24: @@
 To save, click on the button: '''Change'''
 [[File:En_language_add_03.jpg|500px]]
@@ Line 34: / Line 31: @@
 Select the added language in the top-right:
 [[File:En_language_add_05.jpg|750px]]
 The project name should now be shown in English.
 [[File:En_language_add_06.jpg|500px]]
@@ Line 85: / Line 79: @@
 Best practice and strongly recommended is to never turn a sandbox project into a production project. Brillant artefacts created in a sandbox shall be moved into production projects curating these e.g. in terms of IDs, status etc.
 =Project Index=
@@ Line 91: / Line 89: @@
 The Project Index can be accessed by clicking on the link:
 [[File:Projectindex.png|450px]]
 Screenshot of the Project index of an example project:
 [[File:Projectindex_en_demo1.png|750px]]
@@ Line 107: / Line 103: @@
 * Click '''add''' to add a BBR-reference in the current project
 Screenshot that shows the user-interface for adding a BBR-reference from a project:
 [[File:En_project_bbr_reference.png|750px]]
 * Click '''Save''' to update the project information
 * After saving the project information, the BBR-reference is shown like:
 [[File:En_project_bbr_reference_added.png|750px]]
 * After adding the BBR-reference: when adding dataset concepts, value sets or templates, content from the BBR is also presented in the current project
@@ Line 171: / Line 163: @@
 Start the compilation process:
 [[File:Development_version_02.png|550px|Compile a development version: compiling]]
 After compiling you can validate XML instances from your desktop against the compiled schematron:
 [[File:Development_version_03.png|950px|Validate XML instance]]
 =Creating a new version / release / publication request=
-ART supports the creation of a project publication. For the publication feature to work, [[ADRAM|ADRAM]] needs to be installed and configured for this project.
+ART supports the creation of a project publication. For the publication feature to work, [[ADRAM|ADRAM]] needs to be installed and configured for this project. The different publication formats are documented here: [[DECOR-Publication|DECOR-Publication]].
 The creation of a version/release works as follows:
 * Log in as '''decor-admin'''
@@ Line 236: / Line 227: @@
 To view the local ids, you don't need to login. To update them you need to have decor-admin privileges and be author in the project. In both cases, go to the Ids tab on the Project form.
-The Ids tab is divided in two sections "External Ids" and "Base Ids". The ''External Ids'' is meant for OID, defined and potentially registered outside the project, and used in the project. The External Ids may be of any type like Identifiers, Identification systems, Code systems etc. The ''Base Ids'' are used as an Identification system for the identification of various DECOR project artifacts and are normally derived from the project id.
+The Project Identifier panel is divided in two sections “Other Ids” and “Base Ids”.
 Add a new id in either section using the appropriate <nowiki>[</nowiki>+<nowiki>]</nowiki> button. Update a description by updating the appropriate fields. Don't forget to Save.
 The base ids also sport the option "Default". When you have multiple base ids for a specific type, you may switch the default base id. Switching the default means that new artifacts of that type will be created using this new default unless you override.
 [[File:En_project_ids_01.png|750px|project ids]]

@@ Line 79: / Line 79: @@
 A project can be marked as private with: 'Is private'?
 The project is not listed in the menus and ignored in searches when this setting is active. This useful for projects in incubation fase. You may still work in the project based on direct URLs
 ==Marking a project as Experimental==

@@ Line 175: / Line 175: @@
 Start the compilation process:
 [[File:Development_version_02.png|550px|Compile a development version: compiling]]
 After compiling you can validate XML instances from your desktop against the compiled schematron:
 [[File:Development_version_03.png|950px|Validate XML instance]]

← Older revision		Revision as of 11:44, 16 March 2021
Line 36:		Line 36:

	[[File:En_language_add_05.jpg\|750px]]		[[File:En_language_add_05.jpg\|750px]]
		+
	The project name should now be shown in English.		The project name should now be shown in English.