Virtual Archive of Logical Empiricism (VALEP)

From VALEP
Jump to navigation Jump to search

This is the electronic manual of VALEP. In addition to this page, you can find more information on the following pages:

Contents

Practical tips and hints for first time users of VALEP

  • Only material with resolved copyright issues is openly available in VALEP, the rest is accessible for registered users only.
  • VALEP is optimized for the Chrome browser and works well with Firefox; other browsers might also work but have not yet been tested.
  • VALEP sometimes gets hung up: try to click on a node or button for a second time, this will resolve the problem in most cases.
  • if VALEP gets hung up continuously, or you encounter other problems, we recommend resetting VALEP with the F5 key or by clicking the refresh button of your browser.
  • VALEP is best suited for 4K screens but also works well in full HD; smaller screens also work, but it might become tedious at times; VALEP has not yet been adapted for smartphone use.
  • You can adjust the sections of your VALEP screen by moving the borders of each section (reset to the initial state with F5).
  • If your screen tends to be too small, try to maximize the VALEP window with the F11 key.
  • You can use several instances of the VALEP window simultaneously: open different VALEP objects in different browser tabs or browser windows, or even different browser brands.
  • If you created or updated an entry in the database, a green message will confirm a successful update at the server level; however, at times, you may need to refresh the browser window, so that the information will also be visible on the screen.

The public part

You access the public part of VALEP when you visit valep.vc.univie.ac.at without logging in. The VALEP window consists of the archive tree (on the left/red), the document section (in the middle/green), the metadata window (top right/yellow), and the file viewer (bottom right/blue). Versions contain those files of the archive tree that belong to a document and therefore connect the archive tree and the document section. Chapters combine several documents, represented in the bottom document window.

Adjust borders and press F5

The borders between the different screen sections (archive tree, top and bottom document window, metadata window, file viewer) can be adjusted. This allows you to customize the size of the screen sections as needed.

Whenever you want to reset the screen layout to its initial state, just press the F5 key. But please note that this will delete any changes you made to the screen. You will return to the screen that you see when you first visit valep.vc.univie.ac.at.

Archive tree (elements)

This is only an overview. For the details, see the respective section on the metadata page.

The general structure of the archive tree is this:

  • Archives (this is only the root of the tree, which does not represent anything in itself)
    • Archive X (A physical archive or repository, either public or private)
      Examples: Institute Vienna Circle, Archives of Scientific Philosophy, Xs private collection
      • Y Collection (A collection that represents holdings on an authority Y, which can be either a person or an institution - Y collections might exist in several archives)
        Examples: Carnap collection, Vienna Circle collection
        • Box O (Boxes might contain ...
          • Box P ... sub-boxes or folders, but no files)
            • Folder S (A folder is a box that is either empty or contains files and/or versions)
              • Version F (this is a list of files that is associated with a document - versions can only be created within a general document)
                Examples: Original letter Neurath to Carnap, 1935-05-12; Copy of Carnap, From Chaos to Reality
              • File a (A folder might contain several files arranged in VALEP according to the alphabetic order of the file names - non-trivial metadata can be associated with files via versions only)
                Files can be photos (jpg), text files (pdf), audio (mp3) or video files (mp4)

Archive tree (click and double click)

  • An arrow on the left of an element indicates that there is content their. Just click on the arrow and the content folds out. Click the arrow again and the content is hidden again.
  • Click on an Element, to display the metadata in the top right window
  • Double click on a version, to display the document in the bottom middle window
  • Double click on a file, to display the sequence of files to which it belongs in the file viewer

Documents (top window)

In the upper part of the document window, a list of all VALEP documents is shown, which is per default sorted by the processing date of the documents (the most recently edited document shows up on top). These are possible actions:

  • Sort the documents in a different way. Options are
    • Sort by processing date (most recently edited top)
    • Sort by title (A top, Z bottom)
    • Sort by document date (oldest top)
    • Group by authors (A top, Z bottom), sort by date (oldest top)
  • Filter the documents. You can (de)activate the filter by clicking on the active box.
    To change the filter click Filter and select among the options:
    • Full Text: this covers recently only title and description
    • Document category, display, e.g., only letters or photographs
    • Date, select all documents whose date matches the date or period you are entering (you may use the EDTF format only)
    • Location, select all documents whose location matches the entered address, city, or area (not available yet, coming soon)
    • Collection, select all documents that belong to any instance of the X collection (not available yet, coming soon)
    • And Box, activate, to select those documents that match the author, receiver, and involved authorities you are entering, deactivate, to combine these filters with a logical "OR"
    • Author, Receiver, Involved: You may enter in any of this field several persons or institutions, in order to display those documents that match these criteria

There are similar clicking operations here as in the archive tree. Only differences:

  • Double click on a document opens the document (and its chapters) in the bottom document window
  • Double click on a version opens the version in the archive tree (not available yet, coming soon)

Documents (bottom window)

In the public view the purpose of the bottom window is twofold:

  • To view all chapters of a document
  • To view a document whose version was doubleclicked in the archive tree

Versions

Versions connect documents and files. In other words, they are the missing link between the archive tree and the document window. Note these features:

  • Documents might contain any number of versions of any version type
  • Double click the title of a version in the top or bottom document window, to display this version in the archive tree (coming soon)
  • Double click the title of a version in the archive tree to display the document in the bottom document window
  • Double click on any file of a version, to display the sequence of files of the version in the file viewer
  • Click on a version, to display its metadata
  • Note that each version of a document has extra metadata that add to the overall metadata of the general document

Chapters

Chapters are sequences of general documents that put together several parts of, e.g., a manuscript being spread over different locations. To display the sequence of chapters of a document, you need to doubleclick it in the top document window. The sequence, then, becomes displayed in the bottom document window.

Metadata Window

For all elements of the archive tree, the metadata window is just one-piece.

For general documents and versions, the metadata window disintegrates into four parts, vertical, from top to bottom:

  • The status line that comprises the document category, document type, and title of a document
  • The General section that contains the most relevant metadata of general documents
  • The Details section that covers the rest of the metadata of general documents
  • The Version section that covers the metadata of versions

The File Viewer

The file viewer changes its appearance for different types of files: an image viewer (for jpgs), a pdf viewer, and a video viewer for mp3s and mp4s.

  • Use the cross-in-a-circle-symbol in the upper right corner to maximize the file viewer, return wis Esc or another click on the symbol
  • Click through the files in the list on the left, in the top status line and with the arrows at the bottom of the window
  • Use the arrows ↻ and ↺ to rotate the image or pdf
  • Use the + and - symbols or the mouse wheel to decrease or increase the view
  • Use the maximize icon above the file list to fit an image to the screen
  • Use the pdf symbol to download a pdf that includes the entire sequence of jpgs from the file list (not yet implemented, coming soon)

The internal part (Construction Site) - registered users only

User accounts and roles

To access the internal part of VALEP and/or view the restricted files of the public view, you need to register. In order to register send an email to Christian Damböck where you might indicate your plans. We then will decide together, what type of access is applicable in your case.

These are possible user roles in VALEP. Which role you might obtain, depends on your tasks and relationship to the IVC and/or the institutions that host material in VALEP:

Read only

  • Friend is a user who gets reading access to all restricted files in the published part VALEP
    This user role is restricted to members, friends, and close cooperation partners of the IVC
  • Guest is a user who gets reading access to a selection of the internal part (not yet implemented, coming soon)
    This is for all users who get granted reading access to parts of the internal material in VALEP
  • Member is a user who gets reading access to all objects of the published and internal part of VALEP
    This is for members of the IVC only

Read and write

  • Beginner is a user who gets full read and write access to those published and unpublished objects of VALEP where the user is specified as owner.
    This is suited to every user who wants to learn VALEP and use it in any possible way
  • Advanced is a user who gets full read and write access to all parts of VALEP
    For members of the IVC only
  • Admin has also access to the Admin part of VALEP.

Login

After logging in with your user account, depending on your user role, VALEP might look differently:

  • Friend: VALEP does not change its appearance but you can view the content of every file
  • Guest and Member: in the top left corner, to the right of the elephant, you have two buttons Constrution and Public now
    • Public restricts what you see to the public part of VALEP -- you may use it at times, to get a better overview
    • Construction adds to the public material (font color black) material that is only visible in the internal construction site of VALEP (font color grey)
  • Beginner and Advanced: like Guest and Member you may shift between the Public and Construction view; in addition:
    • You can see the toolbar that allows you to call certain operations: upload files and folders, add nodes to the archive tree, create documents, and delete objects
    • You may add objects to and remove objects from all these nodes in the archive tree where you have permission
    • You may create general documents and versions and you may also delete them, if you have permission
    • You may change metadata for all these objects where you are permitted to do so

How to edit fields in the metadata window

  • Some of the metadata fields are rather self explanatory - just try to use them
  • Examine the metadata page, before you start

Text fields

  • Text fields (title, description, URL) may contain any UNICODE text
  • Just enter or edit the text
  • As soon as you klick somewhere outside of the text field you should see the green message box ""Updated X successfully

Persons/Institutions

  • Most metadate fields of the category person/institution may contain several entries
  • Enter some characters of the name of the person or institution you want to specify
  • If the correct name shows up, click on it or move down with the keyboard and press enter
  • If the name is not on the list, press + on the right of the metadata field (not yet implemented but coming soon)
    • Select Person or Institution
    • Enter an abbreviated name, which needs to be unique
    • Enter any further data, as needed
    • Click OK
  • Optionally, you may enter further persons/institutions (unless the data field accepts only one entry)
  • Click somewhere else and watch out for the Updated X successfully message

Language, Card File, Document Format, Copying Process

  • Enter some characters of the name you are searching for
  • If the correct name shows up, click on it or move down with the keyboard and press enter
  • If the item you need does not exist, ask the admin to create it for you

Date

  • Most metadata fields of the category date may contain several date-time entries
  • Enter the first string in the field which should match the EDTF format as outlined in the metata page
  • Press ENTER (this is required, otherwise the date field is NOT going to be updated)
  • If required, also enter further EDTF strings and each time press ENTER again (unless the data fields accepts only one date)
  • Click somewhere outside and watch out for the Updated X successfully message
  • This is the point where the date entries are sent to the parser, i.e., if you entered in invalid date (try, e.g., 1910-12-32) you get an error message Invalide EDTF data and the wrong entries are getting removed
  • Try this several times, because it needs some acquaintance to get settled with this

Location

  • Most metadata fields of the category location may contain several location entries
  • Try first to enter several characters of the address that you plan to enter (cf. the specification in the metadata page)
  • If the address you want to specify shows up in the list, just click on the item or move down with the keyboard and press enter
  • If the address is not in the list, press the + symbol on the right of the data field
  • Enter city: again, type several characters of the city name, if it shows up just select the city; otherwise click the + symbol:
    • Enter the city name
    • Then specify the most convenient area
    • This should be the smallest area to which the city belongs
    • Ask the admin, if you have troubles with this, but note also that the assignment of the city to an area could also be changed later
  • Enter further information (street, postal code, etc.), if applicable
  • Leave these further fields empty, if the address should only specify the name of a city
  • Click OK or press enter
  • Optionally, you may enter further addresses to the field (unless the data field accepts only a single location)
  • Click somewhere else and watch out for the Updated X successfully message

Event

  • Most metadata fields of the category event may contain several event entries
  • Try first to enter several characters of the event that you plan to enter (cf. the specification in the metadata page)
  • If the event shows up on the list, click it or move down with the keyboard and press enter
  • If the event does not show up, press the + symbol on the right of the data field
    • Type in a label and select an event type (required)
    • Optionally, you may also add location, address, and a description of the event
    • Click OK to create the event
  • Optionally, you may enter further events to the data field (unless the data field accepts only a sengle event)
  • Click somewhere else and watch out for the Updated X successfully message

How to create, edit, and delete parts of the archive tree

Operations in this section are accessible only to some users, as indicated in the login section.

How to create, edit, and delete an archive

  • Right click on Archives and click Add child node / or click on archives and then click + in the toolbar
  • Enter the name of the newly created archive and press Ok or type Enter
  • To edit the archive, click on the name of the new archive and enter or edit the metadata (note that the owners field can be changed only by the admin)
  • To delete the archive, right click on the name and click Delete / or click on the name and then on the paper basket symbol in the toolbar

How to create, edit, and delete a collection

  • Right click on the archive where you want to establish the collection and click Add child node / or click on the archive and then click + in the toolbar
  • Enter some characters of the name of the person or institution the collection is representing, then select the correct name from the list (either click or move down with the keyboard and press enter) and press Ok or type Enter
    • If the person or institution you are needing is not in the list, ask the admin to create it for you
  • To edit the collection, click on the name of the new collection and enter or edit the metadata (note that the owners field can be changed only by the admin)
  • To delete the collection, right click on the name and click Delete / or click on the name and then on the paper basket symbol in the toolbar

How to create, edit, and delete a digitization

Note that you can also upload a folder to a collection, which then is automatically interpreted as a digitization: see How to upload a folder

  • Right click on a collection and click Add child node / or click on the collection and then click + in the toolbar
  • Enter the name of the newly created digitization and press Ok or type Enter
  • To edit the digitization, click on the name of the new digitization and enter or edit the metadata (note that the owners field can be changed only by the admin)
  • To delete the digitization, right click on the name and click Delete / or click on the name and then on the paper basket symbol in the toolbar

How to create, edit, and delete a box

You may usually create boxex not directly but upload it from your computer: see How to upload a folder; however, it might be sometimes useful to create boxes directly, in order to structure the content of a digitization:

  • Right click on either a digitization or a box and click Add child node / or click on the collection and then click + in the toolbar
  • Enter the name of the newly created box and press Ok or type Enter
  • To edit the box, click on the name of the new digitization and enter or edit the metadata (note that the owners field can be changed only by the admin)
  • To delete the box, right click on the name and click Delete / or click on the name and then on the paper basket symbol in the toolbar

How to upload files to the archive tree

Operations in this section are accessible only to some users, as indicated in the login section.

How to prepare files and folders for uploading

A key aspect of VALEP is that you can upload arbitrarily nested structures that belong to a folder, i.e., an uploaded folder might contain folders, subfolders, subfolders of subfolders etc. However, please note the following restrictions and hints:

  • Use either Firefox or (even better) Chrome
  • Uploaded folders may not contain any files having extensions other than .jpg, .pdf, .mp3, or .mp4
  • File names must not contain dots except for the one that precedes the file name extension (such extra dots will become replace with a hyphen)
  • No folder in the uploaded folder structure may contain both files and folders; in other words, files are contained in a special type of folder in VALEP, which cannot contain folders among files
  • Folders and files are ordered in the archive tree, exclusively, in an alphabetic way; this alphabetic order is critical, because you can only entire entire subsequences of an alphabetically ordered content of a folder to a version
  • jpgs must be compressed to less than 600KB; though VALEP is also able to compress the files during the uploading process this might slow down the process and compression during the upload sometimes fails
  • Try also to keep your pdfs, mp3 and mp4 files small; there is no internal compressing of these files; any file that you upload to VALEP must not be larger than 15MB
  • If a folder contains more than 1.000 files and/or 1GB, please discuss the upload in advance with the admin
  • Note that very large uploads (of several 10,000 files) might become more tricky, never try them without assistance of the admin

How to upload a single folder

  • First read the previous section and prepare your files and folders in a sufficient way
  • Click on the collection, digitization, or box where you want to place your folder
  • Click on the upload folder symbol in the middle of the toolbar
  • Select the folder on your local computer and press OK

How to upload several folders at once

  • To upload several folders at once to a specific folder X you first need to put these folders on your local computer to a folder also named X
    • X at the local computer may also contain folders being already uploaded to X at VALEP - these will be ignored during the upload process, i.e., if you want to add further material to an already uploaded subfolder of X you need to do it in a different way
    • If you want to upload several folders directly to a collection called X collection (e.g., Carnap collection) the folder on your local folder must be called X rather than X collection (or Carnap rather than Carnap collection)
  • Click on the folder X (or X collection) to which you want to upload the bunch of folders
  • Click on the upload folder symbol in the middle of the toolbar
  • Select the folder X on your local computer and press OK

How to upload files

The standard way of getting files into the archive tree is to upload a folder. However, in some cases it might be necessary to upload just several files into an existing folder:

  • Examine the hints in the upload a folder section.
  • Ensure that the box/folder to which you plan to upload your files is either empty or only contains files
  • Click on the box or folder where you want to place your files
  • Click on the upload files symbol in the middle of the toolbar
  • Select the files on your local computers (several files might be selected at once) and click OK

How can I track the upload? How can it fail?

  • In the toolbar, the progress of your upload is reportet; typically, it uploads 4 files in a batch, uploading of one batch should take only a few seconds
  • To track the success report and possible error messages during the upload press F12 in Chrome or Firefox and select Console
  • If you interrupt the process by shutting down the browser or the computer, the upload fails and there is no possibility to continue; in that case, just delete the initial fragmented upload and try again
  • If the upload fails several times, please contact the admin
  • These are known cases that lead to problems with the upload of specific files:
    • Jpgs being larger than 600KB sometimes cannot be compressed by VALEP, which leads to an error message and failure of the upload of this file
    • If a file contains a dot somewhere in the file name, VALEP deletes those parts of the file name between the dot and the file name extension; though the upload works, the resulting cropped file name may corrupt the intended ordering of the uploaded files
    • Files, in general, must not be larger than 15MB

How to create, edit, and delete general documents

Operations in this section are accessible only to some users, as indicated in the login section.

How to create a general document

Before you create a general document, please examine the details on general documents in the metadata section.

  • Click on the create new general document symbol in the toolbar or right click in the upper document window and click Create new general document
  • In the New Document window you need to select the Document Category (which cannot be changed later), if the document is a file card you also need to select the card file to which it belongs
  • All other metadata fields in the New Document window are optional; deal with them to your taste, you can change the data at any time
  • If you have questions about how a particular metadata category works, please consult the metadata page
  • Press OK when you are done

Who can edit or delete a general document?

  • Responsible for this is the Document status which is indicated in the Details section of a general document
  • General documents with the document status Beginner can be edited or deleted by any user who has writing permissions
  • General documents with the document status Advanced can not be edited or deleted by users whose role is Beginner
  • General documents with the document status Admin can be edited or deleted only by the admin
  • The document status can be changed by the admin only

How to edit a general document

  • If necessary, search for the document using the filter tab and the ordering function
  • Click on the document either in the upper or the lower document window
  • Change any metadata in the upper section (document type, title), in the General or Details section
  • Note that you cannot change the document category and the card file (exists only for file cards), cf. the next paragraph
  • Note that the Document status can be changed only by the admin

How to change the document category or file card to which a document is asigned

  • The only way is to delete the document and create a new one with the correct document category and/or file card
  • Better first create the new document and then delete the old one, to prevent losing information

How to delete a general document

  • Click on the general document and then click on the paper basket symbol in the toolbar
  • Read the Who can edit or delete a general document? section, if it doesn't work

How to create, edit, and delete versions

Before you proceed, read the versions section in the metadata page. Operations in this section are accessible only to some users, as indicated in the login section.

Who can create, edit or delete a version?

How to create a version

  • Double click the general document to which the version will belong in the upper document window -- it should show up in the lower document window
  • Select the files of the versions in the archive tree: click on the first file of the sequence, hold Shift, then click on the last file of the sequence
  • Click on the selection and pull it to the appropriate Add version entry in the list in the lower document window
  • Move the mouse slowly and, in the lower document window, wait until the appropriate Add version line is getting gray - this will take a few seconds: only then you may release the mouse
  • Wait a few seconds: if the version contains many files, it may take a while until the green Successfully created new Version" message pops up
  • If it doesn't work, try again!

How to edit a version

  • Click on the version
  • Edit the Version tab in the metadata window

How to delete a version

  • Open the version in the lower document window
  • Right click on the version and press Delete or click on the version and then on the paper basket symbol in the toolbar

How to create, edit, and delete chapters

Operations in this section are accessible only to some users, as indicated in the login section.

What is a chapter?

  • Several general documents can be combined to a sequence of chapters
  • Each general document can be part of at most one sequence of chapters
  • To see the sequence of chapters to which a general documents might belong, you need to open it in the lower document window (just double click the document in the upper window or double click any of its versions in the archive tree)

How to add a chapter

  • Open the chapter sequence in the lower document window to which you want to add a chapter (double click in the upper document window on any general document that belongs to the sequence or double click in the archive tree on any version that belongs to the sequence)
  • Click in the upper document window on the document that you want to add to the sequence and pull it carefully to the correct position in the lower window (the document is placed correctly if you can see a horizontal blue stroke), then release the document
  • Try again, if it didn't work!

How to remove a chapter

  • Open the chapter sequence in the lower document window from which you want to remove a chapter (double click in the upper document window on any general document that belongs to the sequence or double click in the archive tree on any version that belongs to the sequence)
  • Right click on the chapter you want to remove and click Remove chapter
  • Do NOT click Delete because this would delete the entire document!

The internal part (Admin)

There is an internal part in VALEP, which is accessible to the admin only, who can edit the following things there:

  • Users can be created, edited and removed
  • A number of tables and structures that contain important data of VALEP can be edited here; these include:
    • Document formats
    • Copying Processes
    • Institutions
    • Persons
    • Locations
    • Events
    • Card Files

Some of these structures can be also edited in a limited way in the Construction Window. This includes the following things:

  • Addresses and Cities can be created directly in the metadata window by any authorized user: just click the plus symbol on the right of a location field
  • Events can be created in the metadata window by any authorized user: just click the plus symbol on the right of an event field
  • Persons and Institutions can be created in the metadata window by any authorized user (in a future version of VALEP)

In general, however, changes to the Admin section are to be done by the admin.