You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Basic Information

A directory which describes a publication consists of:

  • a publication.properties file which describes the publication,
  • a file with the bibliographic description of the publication (in other words, a metadata file), and
  • the files comprising the publication.

The publication.properties file


The publication.properties file is the publication properties file. It consists of key–value pairs. A key, that is, the name of a property, is separated from the value with the equal sign (=). Each such pair is in a separate row. The file should be saved as UTF-8 encoded

The permitted properties and their values are presented below.

  • The publication.actorsRights.<the login of the user or the name of the group to which the permissions are assigned> key. Comma-separated permissions. Note: if the login contains spaces, they must be preceded with the “\” character. The list of possible permissions (for more information about permissions, see here):


    • pv – access only to published publication versions,
    • pr – access to all publication editions, and
    • pe – publication management.
  • The publication.collections key
    Comma-separated identifiers of collections to which the given publication is to be assigned.
  • The publication.destination.directoryId key
    The identifier of the directory in which the given publication is to be put.
  • The publication.destination.parentPublicationId – the identifier of the group publication in which the publication is to be put.
  • The publication.mainFile
    The name of the main file of a publication (with the extension). The main file must be in the directory which describes the publication.
  • The publication.metadataFile
    The name of the metadata file (with the extension). A metadata file must be in the directory which describes the given publication and must be in one of the formats which are supported by the currently installed metadata import extension (usually, those are the RDF, MARC, or Bibtex formats – see the Importing and Exporting Metadata chapter). If the value for that key is not defined, then the default search is for files with the same name as the name of the main file, with the default extensions for the supported format (for example, rdf, .mrc, or .bib).
  • The publication.name key
    This is a sequence of characters which determines the name of the given publication. If the value for that key is not defined, the application will try to generate the name on the basis of the attribute values (just like in the second step of the new publication creator).
  • The publication.notes key
    This is a sequence of characters which determines the administrative notes for the given publication.
  • The publication.published key
    This is a sequence of characters which determines if the first edition of the publication is to be published. If the value is true, the edition will be published. In any other case, the edition will not be published. The default value is false.
  • The publication.secured key
    This is a sequence of characters which determines if the given publication is to be protected. If the value is true, the publication will be protected. In any other case, the publication will not be protected. The default value is false.
  • The image.content key
    The name of the file which contains the thumbnail of the given edition.
  • The publication.publishingDate key
    The planned date of making the given publication available.

A sample publication.properties file:

publication.properties
publication.actorsRights.publicGroup=pr
publication.collections=2,7,12
publication.destination.directoryId=1
publication.mainFile=index.htm
publication.metadataFile=metadata.rdf
publication.name=Przykładowa publikacja
publication.notes=Stworzone przez Jana Kowalskiego
publication.published=true

In this example, the publicGroup will have the permission to review all publications (the assigned pr permission implies the pv permission). The publication will be assigned to collections with identifiers 2, 7, and 12. The publication will be put in the directory with identifier 1. The main file of the publication will be the index.htm file, and the metadata will be in the metadata.rdf file. The publication will be named Sample Publication, and the administrative notes – Created by Jan Kowalski. The first edition of the newly created publication will be published, and the publication will not be protected.

Group Publications

In order to make a newly created publication a group publication, the main file of the publication (the publication.mainFile key) cannot be defined. If the directory which describes the publication contains subdirectories, they will also be analyzed, and the publications described in them will be added as the subordinate directories of the group publication. The subordinate publications can also be group publications (if no main file is defined for them), so the user can create a hierarchy with any number of levels.

Note: if the added publication is not a group publication, then the main file must be determined.

Planned Publications

The created publication can be a planned publication. For that to be the case, the publication directory can only contain two files: publication.properties and description.rdf. Additionally, file publication.properties can contain the publication.publishingDatekey, the value of which should be the planned date of publication. The allowed date format is: yyyy-MM-dd, where yyyy means the year, MM – month, and dd – day.

Defining the Location of a Publication

In order to create a publication, the user must decide where to put it in the directory structure and the structure of the group publications of the dLibra system. That can be done with the use of property publication.destination.directoryId (the target directory) or publication.destination.parentPublicationId (the superordinate group publication). The priority of the second property is higher, so if both are defined, the target directory will be ignored (the publication will be added to the directory which contains the superordinate group publication).

When a group publication is added, the subordinate publications added with it do not require a direct definition of the target location. Since the superordinate group publication is known at once, the publication.destination.directoryId and publication.destination.parentPublicationId will be ignored

Do stworzenia publikacji niezbędne jest określenie, gdzie w strukturze katalogów i publikacji grupowych systemu dLibra ma być ona dodana. Można posłużyć się w tym celu właściwością publication.destination.directoryId (katalog docelowy) albo publication.destination.parentPublicationId (nadrzędna publikacja grupowa). Druga z tych właściwości ma wyższy priorytet, zatem jeśli zostaną zdefiniowane obie właściwości, to katalog docelowy zostanie zignorowany (publikacja zostanie dodana do tego samego katalogu, w którym znajduje się nadrzędna publikacja grupowa).

W przypadku dodawania publikacji grupowej, dodawane wraz z nią publikacje podrzędne nie muszą mieć bezpośrednio zdefinowanego położenia docelowego. Ponieważ nadrzędna publikacja grupowa jest od razu znana, właściwości publication.destination.directoryId i publication.destination.parentPublicationId zostaną zignorowane.

Defining the Name of a Publication

An added publication must have a name. The name can be specified in one of two ways:

  • directly – specifying the publication.name property, or
  • indirectly – if that property is not specified, the metadata file will be checked with the view to composing the name of the publication in the same way as in the second step of the publication creator. In such a case, then, the user should take care that the metadata used for composing the name are defined.

Inheriting properties in publication.properties files

Mechanizm dziedziczenia został wprowadzony w celu ułatwienia definicji właściwości w sytuacji, gdy wiele dodawanych publikacji ma takie same wartości. Właściwości takie nie muszą być definiowane bezpośrednio w każdym katalogu opisującym publikację, ale można je umieścić w pliku publication.properties w katalogu nadrzędnym (tym, który jest wskazywany w kreatorze masowego ładowania publikacji). Zostaną one odziedziczone do wszystkich dodawanych publikacjach. W poszczególnych publikacjach można zdefiniować wybrane właściwości jeszcze raz, co spowoduje nadpisanie odziedziczonych wartości.

Dziedziczenie właściwości działa również w ramach hierarchii zagnieżdżonych publikacji grupowych. Zatem jeśli tworzona jest publikacja grupowa,
właściwości we wszystkich tworzonych wraz z nią publikacjach podrzędnych są dziedziczone z tej publikacji grupowej, chyba że zostaną nadpisane. Są jednak wyjątki od tej reguły:

  • właściwości definiujące miejsce docelowe (publication.destination.directoryId i publication.destination.parentPublicationId) — publikacja nadrzędna i katalog wynikają ze struktury katalogów,
  • identyfikatory kolekcji (publication.collections) — opisywany mechanizm je pomija, ponieważ mechanizm grupowania publikacji zapewnia dziedziczenie tych właściwości,
  • prawa dostępu do publikacji (publication.actorRights) — jak wyżej.

Dziedziczenie metadanych

Mechanizm ten działa podobnie jak w przypadku dziedziczenia plików publication.properties z tym wyjątkiem, że plik metadanych w katalogu nadrzędnym nazywać się powinien publication.rdf. Zatem, jeśli w katalogu zawierającym katalogi z opisami publikacji zostanie znaleziony plik publication.rdf, zawarte w nim metadane zostaną przypisane wszystkim tworzonym publikacjom. Dziedziczenie to działa tylko na pierwszym poziomie katalogów — nie dotyczy publikacji zgrupowanych w nowo tworzonych publikacjach. Dziedziczenie metadanych z publikacji grupowych jest obsługiwane przez mechanizm grupowania publikacji.

Generowanie przykładowego pliku właściwości

Używając Zapisz plik właściwości z menu Narzędzia możliwe jest zapisanie informacji opisujących publikację wybraną na liście elementów do pliku. Plik taki może służyć jako wzór pliku jaki powinien znaleźć się w katalogu opisującym publikację dla masowego ładowania publikacji.

  • No labels