xml:lang="en" lang="en" dir="ltr">

Manuscript Desk2 Manuscript Desk2 Manuscript Desk2 Manuscript Desk

From ManuscriptDesk

Difference between revisions of "Overview"

Jump to: navigation, search
 
(32 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
== Creating New Manuscript Pages ==
 
== Creating New Manuscript Pages ==
 +
 +
New manuscript pages can be created in [https://manuscriptdesk.uantwerpen.be/md/Special:NewManuscript Special:NewManuscript].
  
 
Manuscript pages can contain any content, from any author, as long as the image format is either .jpg or .jpeg.  
 
Manuscript pages can contain any content, from any author, as long as the image format is either .jpg or .jpeg.  
Line 7: Line 9:
 
the pages are, for example, part of the same book.
 
the pages are, for example, part of the same book.
  
New manuscript pages can be created in [https://manuscriptdesk.uantwerpen.be/md/Special:NewManuscript Special:NewManuscript].
+
[[File:ManuscriptDeskNewPage.jpg|1000px]]
  
 
== Editing Manuscript Pages ==
 
== Editing Manuscript Pages ==
  
Once you have uploaded your first manuscript page, you have the ability to edit its content. When you click on the 'Edit' button, you will see the TEI-editor, in which you can  
+
Once you have uploaded your first manuscript page, you have the ability to transcribe its content. When you click on the 'Edit' button, a TEI-editor will appear, in which you can  
 
add TEI-tags to your page by clicking the corresponding tag buttons. If the tag you want is not available in one of the buttons, you can still use the tag by typing it manually.
 
add TEI-tags to your page by clicking the corresponding tag buttons. If the tag you want is not available in one of the buttons, you can still use the tag by typing it manually.
 +
 +
[[File:ManuscriptDeskEditor.jpg|1000px]]
  
 
==== Zoom Viewer ====
 
==== Zoom Viewer ====
Line 23: Line 27:
 
In the top-right corner of the editor, you can see 'maximise/minimise' buttons that allow you to transcribe your manuscript page in full-screen mode.  
 
In the top-right corner of the editor, you can see 'maximise/minimise' buttons that allow you to transcribe your manuscript page in full-screen mode.  
  
==== Additional Editor Features ====
+
==== Additional Editor Information ====
  
 
When saving the page, you can choose to view a preview, to show the changes to the current page, and to choose to watch the page. Watching the page allows you to keep track of the changes on the page.  
 
When saving the page, you can choose to view a preview, to show the changes to the current page, and to choose to watch the page. Watching the page allows you to keep track of the changes on the page.  
 
You can always see the changes made to pages that you are currently watching in [https://manuscriptdesk.uantwerpen.be/md/Special:Watchlist your watchlist].  
 
You can always see the changes made to pages that you are currently watching in [https://manuscriptdesk.uantwerpen.be/md/Special:Watchlist your watchlist].  
 
For additional documentation on this feature, see [https://www.mediawiki.org/wiki/Help:Watchlist the mediawiki documentation].  
 
For additional documentation on this feature, see [https://www.mediawiki.org/wiki/Help:Watchlist the mediawiki documentation].  
 +
 +
Any user with appropriate permissions can edit any manuscript page. This means that you can create a project, and collaborate with other users.
  
 
== Collections ==
 
== Collections ==
  
Collections are a way in which multiple manuscript pages can be tied together. A collection can be specified when creating a new manuscript page. The collection name is visible underneath the manuscript page name.
+
Collections are a way in which multiple manuscript pages can be tied together. A collection can be specified when creating a new manuscript page. On a manuscript page, the collection name is visible underneath the manuscript page name.
  
 
====The Collection Page====
 
====The Collection Page====
 
Once you have created a collection, you can view its collection page by navigation to it using [https://manuscriptdesk.uantwerpen.be/md/Special:UserPage your user page]. This page shows every page
 
Once you have created a collection, you can view its collection page by navigation to it using [https://manuscriptdesk.uantwerpen.be/md/Special:UserPage your user page]. This page shows every page
 
created for the collection, its creation date, and the current metadata of the collection. This page can also be used to change the titles of manuscript pages in the collection, to edit the metadata,
 
created for the collection, its creation date, and the current metadata of the collection. This page can also be used to change the titles of manuscript pages in the collection, to edit the metadata,
or to add more manuscript pages to the collection. This information is visible to any user, however, only the owner (creator) of the collection can edit the values.
+
or to add more manuscript pages to the collection. This information is visible to any user. However, only the owner (creator) of the collection is shown additional options that allow changing information in the collection.
 +
 
 +
[[File:ManuscriptDeskCollectionsPage.jpg|1000px]]
  
 
====Collection Metadata====
 
====Collection Metadata====
Line 43: Line 51:
  
 
==== Going To Previous/Next Page Within a Collection ====
 
==== Going To Previous/Next Page Within a Collection ====
If you have more than 2 pages in your collection, these pages will be ordered alphabetically, and on each of the manuscript pages belonging to the collection, a button will appear to navigate to the previous/or next page of the collection. If the ordering is not right, you have the ability to change the title of one or more of the manuscript pages in the collection by navigating to the collection page using [https://manuscriptdesk.uantwerpen.be/md/Special:UserPage  your user page].
+
When you have more than 1 page in your collection, these pages will be ordered alphabetically. On each of the manuscript pages belonging to that collection, a button will appear that allows you to navigate to the previous, or next page of the collection. If the current ordering of the pages in the collection is not right, you have the ability to change the title of the manuscript pages in the collection by navigating to the collection page using [https://manuscriptdesk.uantwerpen.be/md/Special:UserPage  your user page]. Changing the title of a manuscript page enables you to alter the alphabetical ordering of the manuscript pages in a collection. Note that this feature is only available for the owner (creator) of the collection.  
  
 
====Adding Page Specific Metadata====
 
====Adding Page Specific Metadata====
If the metadata you want to add is specific for a single page, you can add this metadata by, for example, writing the following block in the '''bottom''' of the transcription of the manuscript page:
+
If the manuscript page you want to transcribe has metadata that only applies to that manuscript page, and not to the entire collection, you can add this metadata by, for example, editing the transcription of the manuscript page, and writing the following tags in the '''bottom''' of the transcription:
  
 
'''opentag'''pagemetatable'''closetag'''<br>
 
'''opentag'''pagemetatable'''closetag'''<br>
Line 57: Line 65:
 
== Collating Manuscript Pages ==
 
== Collating Manuscript Pages ==
  
Once you have created more than 2 manuscript pages, you have the ability to collate these pages using [https://manuscriptdesk.uantwerpen.be/md/Special:BeginCollate the collation module]. This feature is also available for collections.
+
Once you have created more than 1 manuscript page, you have the ability to collate these pages using [https://manuscriptdesk.uantwerpen.be/md/Special:BeginCollate the collation module]. This feature is also available for collections.
Keep in mind that there is a maximum number of pages that can be collated. If your collection exceeds the maximum number of pages that can be collated, it will not appear in the list.  
+
Keep in mind that there is a maximum number of pages that can be collated. If your collection exceeds the maximum number of pages that can be collated, it will not appear in the list, and you will not be able to collate this collection with any other page or collection.
 +
 
 +
After collation, you have the ability to save the result. The saved collation can be found and viewed using [https://manuscriptdesk.uantwerpen.be/md/Special:UserPage your user page].  
  
After collation, you have the ability to save the results of the collation. The saved collation can be found and viewed using [https://manuscriptdesk.uantwerpen.be/md/Special:UserPage your user page].
+
[[File:ManuscriptDeskCollation.jpg|1000px]]
  
== Overview Pages ==
+
== Summary Pages ==
  
 +
There are various pages that help you find manuscript pages created by other users. See for example [https://manuscriptdesk.uantwerpen.be/md/Special:AllManuscriptPages Special:AllManuscriptPages], or [https://manuscriptdesk.uantwerpen.be/md/Special:RecentManuscriptPages Special:RecentManuscriptPages]
  
 +
[[File:ManuscriptDeskRecentPages.jpg|1000px]]
  
  
Line 70: Line 82:
  
 
At its core, this website is powered by MediaWiki software, the same software that runs on [https://www.wikipedia.org/ Wikipedia]. Because of this, users with appropriate permissions can create new pages anywhere on the website.
 
At its core, this website is powered by MediaWiki software, the same software that runs on [https://www.wikipedia.org/ Wikipedia]. Because of this, users with appropriate permissions can create new pages anywhere on the website.
For example, once logged in, you can go to any url that does not exist (for example manuscriptdesk.uantwerpen.be/w/example), and create a new page here. These pages can be used for different purposes,
+
For example, once logged in, you can go to any url that does not exist (for example https://manuscriptdesk.uantwerpen.be/md/example), and create a new page here. These pages can be used for different purposes,
 
such as storing information on certain authors, and linking to your own transcriptions in the Manuscript Desk, or to external recourses. For these pages you can use [https://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup].
 
such as storing information on certain authors, and linking to your own transcriptions in the Manuscript Desk, or to external recourses. For these pages you can use [https://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup].

Latest revision as of 14:04, 2 December 2015

This page gives a short overview of the features in the Manuscript Desk. This overview assumes that you are logged in, and have privileges to access all the features in the Manuscript Desk.

Creating New Manuscript Pages

New manuscript pages can be created in Special:NewManuscript.

Manuscript pages can contain any content, from any author, as long as the image format is either .jpg or .jpeg. Manuscript pages can also be added to a collection. A collection is simply a way for the user to specify that different manuscript pages belong together, because the pages are, for example, part of the same book.

ManuscriptDeskNewPage.jpg

Editing Manuscript Pages

Once you have uploaded your first manuscript page, you have the ability to transcribe its content. When you click on the 'Edit' button, a TEI-editor will appear, in which you can add TEI-tags to your page by clicking the corresponding tag buttons. If the tag you want is not available in one of the buttons, you can still use the tag by typing it manually.

ManuscriptDeskEditor.jpg

Zoom Viewer

The zoom viewer requires flash player. If you do not have the appropriate plugin for your browser, you can download it here. If the flash player does not work for you, you can use the javascript viewer instead.

Maximise/Minimise

In the top-right corner of the editor, you can see 'maximise/minimise' buttons that allow you to transcribe your manuscript page in full-screen mode.

Additional Editor Information

When saving the page, you can choose to view a preview, to show the changes to the current page, and to choose to watch the page. Watching the page allows you to keep track of the changes on the page. You can always see the changes made to pages that you are currently watching in your watchlist. For additional documentation on this feature, see the mediawiki documentation.

Any user with appropriate permissions can edit any manuscript page. This means that you can create a project, and collaborate with other users.

Collections

Collections are a way in which multiple manuscript pages can be tied together. A collection can be specified when creating a new manuscript page. On a manuscript page, the collection name is visible underneath the manuscript page name.

The Collection Page

Once you have created a collection, you can view its collection page by navigation to it using your user page. This page shows every page created for the collection, its creation date, and the current metadata of the collection. This page can also be used to change the titles of manuscript pages in the collection, to edit the metadata, or to add more manuscript pages to the collection. This information is visible to any user. However, only the owner (creator) of the collection is shown additional options that allow changing information in the collection.

ManuscriptDeskCollectionsPage.jpg

Collection Metadata

If you are the owner (the creator) of the collection, you also have the ability to edit the collection metadata, which can be viewed on the bottom of every page belonging to that collection. You can do this by either clicking on the 'Edit Collection Metadata' link on the manuscript page, or by navigating to the collection page using your user page.

Going To Previous/Next Page Within a Collection

When you have more than 1 page in your collection, these pages will be ordered alphabetically. On each of the manuscript pages belonging to that collection, a button will appear that allows you to navigate to the previous, or next page of the collection. If the current ordering of the pages in the collection is not right, you have the ability to change the title of the manuscript pages in the collection by navigating to the collection page using your user page. Changing the title of a manuscript page enables you to alter the alphabetical ordering of the manuscript pages in a collection. Note that this feature is only available for the owner (creator) of the collection.

Adding Page Specific Metadata

If the manuscript page you want to transcribe has metadata that only applies to that manuscript page, and not to the entire collection, you can add this metadata by, for example, editing the transcription of the manuscript page, and writing the following tags in the bottom of the transcription:

opentagpagemetatableclosetag
Watermarks:=Example
Recto Verso:=Example
opentagforwardslashpagemetatableclosetag

Replace the bold words with actual tags. If succesfull, you will see additional entries above your collection metadata table after saving the transcription.

Collating Manuscript Pages

Once you have created more than 1 manuscript page, you have the ability to collate these pages using the collation module. This feature is also available for collections. Keep in mind that there is a maximum number of pages that can be collated. If your collection exceeds the maximum number of pages that can be collated, it will not appear in the list, and you will not be able to collate this collection with any other page or collection.

After collation, you have the ability to save the result. The saved collation can be found and viewed using your user page.

ManuscriptDeskCollation.jpg

Summary Pages

There are various pages that help you find manuscript pages created by other users. See for example Special:AllManuscriptPages, or Special:RecentManuscriptPages

ManuscriptDeskRecentPages.jpg


Standard MediaWiki features and Additional Documentation

At its core, this website is powered by MediaWiki software, the same software that runs on Wikipedia. Because of this, users with appropriate permissions can create new pages anywhere on the website. For example, once logged in, you can go to any url that does not exist (for example https://manuscriptdesk.uantwerpen.be/md/example), and create a new page here. These pages can be used for different purposes, such as storing information on certain authors, and linking to your own transcriptions in the Manuscript Desk, or to external recourses. For these pages you can use Wiki markup.

Manuscript Desk Home