The Projects Edition Page

Purpose

This screen is used to create, view, update and delete Project records. In the context of Project Hirtius, "projects" are rather simple lesser objects that allow you to link any number of fully-fledged objects (but foremost among them Tiddlers) with a structure that you would create somewhere in your INXtree. The Project record simply provides the entry point in that structure. The structure and all the objects that you will attach to it can then be used to build the draft of your scholarly work (see Projects Report Page).

The creation of a new Project will also create the TiddlyWiki structure that will host all Tiddlers linked with the current project. As already mentioned elsewhere, Tiddlers can't exist by themselves, they are always part of a project. Only through the project can you access the TiddlyWiki interface that will allow you to manipule the tiddlers linked with that project (see Tiddlers (Embedded TiddlyWiki)).

There is more information on the project management feature and how it ties with object records and the INXtree in Projects Management Workflow.

Getting There...

To reach the Edition Page of an existing Project:

From the Main Application Menu (or indeed almost any other Project Hirtius page), click on the "Manage Projects" icon in the header (). This gets you to the Projects List.
Navigate the Projects List until you locate the project you're looking for.
Then click on the project ID (first column), or on any of the action links (last column) to view, edit or delete the project record in question.

Of course, you can also reach the Project view or edition screen through a lot of other ways, such as using search results (see Navigation Tips).

To add a new Project record:

From the Main Application Menu, click on the "Manage Projects" icon in the header (). This gets you to the Projects List.
Press [End] to reach the bottom of the list.
Click the Add action link in the bottom-right corner of the list.

Supported actions

The Project Edition Page supports the following actions:

Add: the form to fill in and submit in order to create a new Project record.
Insert: creating the new Project record in the database (post Add action).
That action will be recorded: a new entry will be added to the Event Log.
Edit: modifying an existing Project record through a form populated based on the current database contents.
Update: storing the modified data in the database, updating the appropriate Project record (post Edit action).
Marking the project as closed will be recorded: a new entry will be added to the Event Log.
View: display the current database contents for the selected Project record. No form in this case.
ReopCon: first step when requesting the re-opening of a record -- issues a prompt for confirmation.
Reopen: the actual re-opening of the selected record (post ReopCon action).
That action will be recorded: a new entry will be added to the Event Log.
DelCon: first step when requesting the deletion of a record -- issues a prompt for confirmation.
Del: the actual removal of the selected record (as well as all linked metadata records) from the database (post DelCon action). Please note, that removing a Project will also remove all the Tiddlers that it still contains and all their past versions (objects of other types that may be linked to the project will not be affected).
That action will be recorded: a new entry will be added to the Event Log.

Of these, only Add, Edit, View and DelCon are entry points. They are typically reached from the Projects List or the Main Application Menu (but in the case of View, there are many more possibilities).

Fields

Here below are the fields that you can expect to find on the Project Edition Page. The goal here is not to simply duplicate the database layout information. If this is what interests you, please refer to the Database Layout, the database creation script or the database itself. The purpose is rather to explain what each field is meant for [D], what format it is expected to follow [F] and what are the conditions for its validity (if applicable) [V].

A star (*) after the name of the field denotes a mandatory field (the star is shown in red with the same meaning in the application user interface).

Object ID*	D	Sequential ID, automatically assigned by the DB during record creation. Displayed read-only once available.
Name*	D	Project name. Make it short, but as explicit as possible. It becomes the title of the TiddlyWiki interface, and will be used as part of the resulting project report title.
	F	Free text.
	V	Has to be unique.
Short desc	D	Short project description. Used to clarify the meaning of the name. Appears as a subtitle in the TiddlyWiki interface. Not used in the project report.
Short desc	F	Free text.
Contents lang	D	Default project contents language. Used to define the language in which you plan to write your project, and by extension the one in which the LaTeX structures and the headings for all Hirtius-specific object meta-data will be rendered in the project report. Defaults to the global application language as set in the Global Definitions File. *Please note:* this field can only be set at project creation time, as it will determine the contents of the default Tiddlers. Post creation, this field is only displayed read-only. Please refer to Language Support in Reports for more information.
Contents lang	F	Drop-down selection.
Structure container node	D	INXtree node tag that is to be used as entry point for this project internal structure. The field itself is read-only and has to be populated by clicking on the Link link just above. The "project report" feature will be disabled unless this field is set.
Project is closed	D	Flags the project as closed when checked. New projects are always created in an 'open' state. When closed, the project record AND all the tiddlers it contains become read/only. Project reports may still be generated for closed projects provided a Structure Container Node was provided before they were closed. Closed projects may be hidden on the Projects List. Closed projects can be re-opened if needed.
Project is closed	F	Checkbox.
Comment	D	Any comment you might have on the project itself (the reason it makes sense to you), or its subject (the larger historical context it is meant to cover, etc). The contents of this field will become the abstract of the resulting project report.
Comment	F	Free text. HTML markup allowed. Special formats: '`{D1234}`': quote another Hirtius object using its object prefix and ID. Automatically rendered as a link to that object view page. See Objects and Metadata Types for a list of all prefixes supported by the application. Only objects and lesser objects can be referred to in this way. '`[1234]`': Bibref. Refers to the bibliographical reference with said number, as defined further down the page in the *References* section. Rendered as a link to a named anchor. Only works with bibrefs attached to the current object. '`[S1234]`': Srcref. Refers to the source reference with said number, as defined further down the page in the *Sources* section. Rendered as a link to a named anchor. Only works with srcrefs attached to the current object. Insert these formats in your text without the enclosing quotes. If the object that you refer to doesn't exist (yet) or is not linked to the current object (in the case of Bibref and Srcref), the reference will be rendered in a special style (orange italics) and the associated link will point to that object creation page (where possible).

Controls

In View mode

Report structure Browse link: Next to the Structure container node field is a Browse link that you can use to open the INXtree Browser on that node (i.e. the entry point to your project's report structure) to browse, maintain or enhance it.
Link to that project's TiddlyWiki: In the upper left corner, just next to the project ID, you'll find a globe icon () that will lead you to the current project's TiddlyWiki interface. This is where you will be able to view, create and edit Tiddlers linked with that project. See Tiddlers (Embedded TiddlyWiki) for a full description of that interface.
Switch to edit mode link: Located at the bottom of the page, just above the footer. Click on this link to edit the current object (switches the view from a R/O rendering of the contents to an HTML form that allows you to modify that contents and submit it afterward).
This link is disabled if the current Project is flagged as closed.
Report link: Located at the bottom of the page, just above the footer. Click on this link to reach the Projects Report Page.
This link is disabled as long as the 'Structure Container Node' has not been selected for the current Project.

In Edit mode

Report structure Link link: Next to the Structure container node field is a Link link that you can use to open the Category Selector to browse the INXtree and select the node that will serve as head to your report structure. Once you return to the Projects Edition Page, please press [F5] to refresh the page in order to show the selected node.
Link to that project's TiddlyWiki: In the upper left corner, just next to the project ID, you'll find a globe icon () that will lead you to the current project's TiddlyWiki interface. This is where you will be able to view, create and edit Tiddlers linked with that project. See Tiddlers (Embedded TiddlyWiki) for a full description of that interface.
Submit button: (Also in "Add" mode). Commits the locally modified HTML form fields contents to the database that stores Project Hirtius data. Use it to save your latest modifications. It is of course perfectly legitimate to click Submit any number of times during a long edition session to avoid loosing unsaved data. When doing so, use the Edit this slide some more... link on the update result screen (see below) to return to the current slide record and edit it further.
Reset button: (Also in "Add" and "Clone" modes). Cancels any un-committed change, and returns all HTML form fields to their initial value (i.e. the one they had when the page was last loaded in the browser). Use this button to revert any erroneous edit you might have done (Beware: this only works on local changes that have not been saved to the database yet, i.e. for which you've not clicked on Submit yet).
Edit References: This will open the Object - Bib. Ref. Edition Page.
Edit Sources: This will open the Object - Source Ref. Edition Page.
Edit Attachments: This will open the Object - Attached File Edition Page.
Switch to view mode link: Located at the bottom of the page, just above the footer. Click on this link to view the current object (switches from the current HTML form that allows you to modify the object contents and submit it afterward to a R/O rendering of that contents).

In Insert or Update result mode

This result page appears once you have clicked the Submit button on the Add or Edit page. It will offer the following links:

View this project link: Brings you back to the current Project record in view mode. Use this link to visually check the effect of the latest changes you submitted.
Edit this project some more... link: Returns you to the current Project record in edit mode. Use this link to further edit the project in question. This link is also present just after you added a new project. You have to use this link to add some of the metadata that can only be attached once the record has been created (bibrefs, srcrefs, attachments, etc.)
Go to Wiki link: This leads you to the current project's TiddlyWiki interface (equivalent to the globe icon in 'view' and 'edit' mode). This is where you will be able to view, create and edit Tiddlers linked with that project. See Tiddlers (Embedded TiddlyWiki) for a full description of that interface.
Add a new project link: Opens the form that allows you to create a new Project record. Usefull when creating multiple records in sequence.