Pomoc:Obowiązująca notacja - reguły tworzenia nazw plików i kategorii

Z ArchiwumHarcerskie.pl
Wersja z dnia 13:12, 10 gru 2021 autorstwa Mgajdzinski (dyskusja | edycje)
(różn.) ← poprzednia wersja | przejdź do aktualnej wersji (różn.) | następna wersja → (różn.)
Przejdź do nawigacji Przejdź do wyszukiwania

Sens wprowadzenia reguł dotyczących nazewnictwa

W Archiwum znajduje się ogromna liczba materiałów archiwalnych przechowywanych w skategoryzowanych plikach. Najprostszym sposobem odnajdywania treści i docierania do nich jest korzystanie z menu nawigacyjnego. Dzięki przyjętym regułom nazewnictwa pliki i kategorie mogą być wyświetlane w sposób uporządkowany; chronologicznie lub alfabetycznie. Menu nawigacyjne jest skonstruowane w taki sposób, aby wyjść na przeciw potrzebom i przyzwyczajeniom większości użytkowników. Ułatwia najbardziej standardowe sposoby docierania do zasobów archiwum. Oprócz tego, część użytkowników zainteresowana szczegółowymi danymi i niestandardowymi zestawieniami danych korzysta z wyszukiwarki. Aby wyszukiwarka prawidłowo i kompleksowo wyszukiwała żądane materiały muszą one być nazwane w taki sposób, aby w nazwie zakodowane były najbardziej istotne informacje o danym pliku, czy kategorii. To umożliwia odnalezienie pożądanych informacji.

Ogólne reguły kodowania informacji w nazwach plików i kategorii

W nazwach plików i kategorii kodowane są podstawowe informacje dotyczące obiektu lub zbioru obiektów archiwalnych (jednostka, zespół, zbiór, kolekcja) jaki ten plik lub kategoria reprezentuje. Informacje te koduje się w następujący sposób.

Znaki inne niż litery i cyfry

Zakazane znaki specjalne

W nazwach plików i kategorii nie wolno stosować znaków specjalnych, czyli takich, które służą do oznaczenia parametrów w adresach URL. Użycie tych znaczników w nazwach plików lub kategorii może powodować, że nie nie będą one mogły być wyświetlone lub ich nazwy zostaną zniekształcone.

Zakazane znaki specjalne to: "?" "&" "#" "$".


Znaki, które zostaną automatycznie ukryte lub zastąpione

Bardzo często w nazwach plików używa się znaku podkreślnika "_". Jest to dozwolone, należy jednak pamiętać, że oprogramowanie archiwum przetworzy do wyświetlenia na ekranie nazwy plików i kategorii zawierające podkreślniki w taki sposób, iż zamieni je na spacje. Zatem nie będą one widoczne na ekranie.

Przykład:

  • Kategoria o nazwie "1999_Jan_Kowalski_pliki" będzie się wyświetlała jako "1999 Jan Kowalski pliki".


Jeśli natomiast w nazwie pliku (obojętnie w jakim formacie) pojawi się spacja " ", nazwa ta zostanie przez system zamieniona na podkreślnik "_".

Przykład:

  • Plik przygotowany do wgrania serwer o nazwie "1999 Jan Kowalski.jpg" zostanie zapisany na serwerze archiwum jako "1999_Jan_Kowalski.jpg".


Znaki, których stosowanie nie jest zalecane

Nie zaleca się stosowania numeracji rzymskiej. Używanie liczb w zapisie rzymskim uniemożliwia poprawne sortowanie i wyświetlanie nazw oraz tytułów w kolejności alfabetycznej.

Przykład:

  • Zamiast: "Tom II", użyj: "Tom 2".


Znaki, które w zwykłym piśmie mają znaczenie gramatyczne, w nazwach plików i kategorii są całkowicie zbędne, powodują wykrzaczanie się adresów URL oraz niepotrzebnie wydłużają zapis, a i tak nie mają znaczenia przy wyszukiwaniu danych w wyszukiwarce.

Należy unikać wszelkich znaków nie będących literami alfabetu (dopuszczalne są polskie litery) i cyframi arabskimi. Dotyczy to także przecinka ",".

Optymalnie jest używanie wyłącznie myślnika "-" i podwójnego myślnika "--" jako separatorów dat oraz kropki "." jako oznaczenia skrótu.


Daty

Informacja umownie nazwana „Daty” służy do określenia czasu powstania materiałów archiwalnych. Informacja czasowa może dotyczyć konkretnej daty lub przedziału czasowego (okresu). Format zapisu dat może mieć wiele wariantów.

Data

RRRR-MM-DD oznacza pełną datę, gdzie RRRR, to rok (4 cyfry), MM to Miesiąc (2 cyfry), DD to dzień (2cyfry).

Przykład:

  • 2021-11-04

Dopuszczalne jest pomięcie dnia, jeśli trudno go precyzyjnie ustalić.

Przykład:

  • 2021-11

Dopuszczalne jest pomięcie miesiąca i dnia. jeśli trudno je precyzyjnie ustalić.

Przykład:

  • 2021

Okres dekady

W przypadku, gdy oznaczenie okresu z jakiego pochodzą materiały jest możliwe wyłącznie w przybliżeniu do dekady, należy użyć znacznika dekady "te" zaraz po roku zaokrąglonego do pełnej dziesiątki lat (bez spacji oddzielającej).

RRR0te

Przykład:

  • 1980te

Okres rozciągający się na przestrzeni dwóch lub więcej lat

Dla oddzielenia daty początkowej od daty końcowej okresu stosuje się separator w postaci myślnika "-". Może to się wydawać dziwne w związku z tym, że ten sam sep0arator służy do oddzielania poszczególnych segmentów daty. Ale Jak się przekonamy w poniższych przykładach, notacja ta zachowuje wymóg jednoznaczności zapisu.

RRRR-RRRR oznacza przedział czasowy wyrażony w pełnych latach, który stosuje się, gdy nie można określić bardziej precyzyjnego przedziału dat.

Przykład:

  • 1980-1989


RRRR-MM-RRRR-MM oznacza przedział czasowy od znanego miesiąca roku początkowego do znanego miesiąca roku końcowego.

Przykład:

  • 1980-08-1981-12.

Dopuszczalne jest pomięcie jednego miesiąca, jeśli trudno go precyzyjnie ustalić.

Przykłady:

  • 1980-08-1982
  • 1980-1981-12


RRRR-MM-DD-RRRR-MM-DD oznacza przedział czasowy wyrażony precyzyjnie od dnia początkowego do dnia końcowego w różnych latach.

Przykład:

  • 1980-08-31-1981-12-13

Dopuszczalne jest pomięcie informacji, jeśli trudno ją precyzyjnie ustalić.

Przykłady:

  • 1980-08-31-1982-12
  • 1980-08-31-1981
  • 1980-08-1981-12-13
  • 1980-1981-12-13

Okres rozciągający się na przestrzeni tylko jednego roku

Dla oddzielenia daty początkowej od daty końcowej okresu trwającego klika miesięcy lub dni w tym samym roku stosuje się separator w postaci dwóch myślników obok siebie "--". Reguła ta pozwala zachować wymóg jednoznaczności zapisu.

RRRR-MM--MM oznacza przedział czasowy kilku określonych miesięcy w jednym roku. Jednocześnie nie ma obowiązku oznaczania przedziału dat w nazwach plików i kategorii w tak precyzyjny sposób. W takim przypadku zupełnie wystarczające jest oznaczenie roku. RRRR

Przykłady:

  • 1982-07--08 (oznaczenie precyzyjne)
  • 1982 (oznaczenie skrótowe - wystarczające)


RRRR-MM-DD--MM-DD oznacza przedział czasowy wyrażony precyzyjnie od dnia początkowego do dnia końcowego w jednym roku. Jednocześnie nie ma obowiązku oznaczania przedziału dat w nazwach plików i kategorii w tak precyzyjny sposób. W takim przypadku zupełnie wystarczające jest oznaczenie roku. RRRR

Przykłady:

  • 1982-07-15--08-10 (oznaczenie precyzyjne)
  • 1982 (oznaczenie skrótowe - wystarczające)

Dopuszczalne jest pomięcie informacji, jeśli trudno ją precyzyjnie ustalić.

Przykłady:

  • 1982-07--08-10
  • 1982-07-15--08


RRRR-MM-DD--DD oznacza przedział czasowy wyrażony precyzyjnie od dnia początkowego do dnia końcowego w jednym miesiącu. Jednocześnie nie ma obowiązku oznaczania przedziału dat w nazwach plików i kategorii w tak precyzyjny sposób. W takim przypadku zupełnie wystarczające jest oznaczenie roku i miesiąca. RRRR-MM

Przykłady:

  • 1982-07-01--25 (oznaczenie precyzyjne)
  • 1982-07 (oznaczenie skrótowe - wystarczające)


Lokalizacja

Dla oznaczenia lokalizacji podajemy możliwie najbardziej precyzyjną informację poczynając od:

Miejscowość – nazwa miejscowości (miasta) o ile jednoznaczna identyfikacja miejsca jest oczywista.

Przykłady:

  • Zakopane

Miejscowość Okolica - nazwa miejscowości i okolicy/regionu pozwalająca na jednoznaczną identyfikację miejsca.

Przykłady:

  • Kurki Olsztynek
  • Olsztyn k.Częstochowy
  • Wykus Góry Świętokrzyskie

Region – nazwa regionu geograficznego, powiatu, województwa, hrabstwa, itp.

Przykłady:

  • Mazowsze
  • powiat przysuski
  • lubuskie
  • Norfolk

Kraj – nazwa państwa lub powszechnie używana nazwa kraju

Przykłady:

  • Szkocja

Uwaga! Nie ma potrzeby kodować pełnej informacji o lokalizacji. Na przykład

  • Warszawa mazowieckie Polska

jest zapisem niezalecanym ponieważ wydłuża nazwę bez potrzeby.


Numer periodyku, pisma lub gazety

nr NNN – liczba poprzedzona prefiksem „nr” informująca o kolejnym numerze w danym roku . Liczby podajemy w zapisie jedno lub kilku cyfrowym w zależności od tego jaka jest całkowita liczba numerów pisma wydanych w danym roku. Jeśli tego nie wiadomo, bo pismo jest nadal wydawane, wtedy dla bezpieczeństwa lepiej przyjąć zapis dwucyfrowy dla miesięczników i dwutygodników lub trzycyfrowy dla gazet codziennych.

  • Zapis jednocyfrowy (N), gdy numerów pisma jest 9 lub mniej niż 9.
  • Zapis dwucyfrowy (0N, NN), gdy numerów pisma jest 99 lub mniej niż 99.
  • Zapis trzycyfrowy (00N, 0NN, NNN), gdy numerów pisma jest 999 lub mniej niż 999.


Tytuł

Tytuł - tytuł utworu, pisemka, gazety, książki, filmu, itp. podajemy w wersji pełnej do długości 100 znaków, a dłuższe w formie skróconej.

Przykłady:

  • Wiadomości Urzędowe
  • Modlitwa Harcerska

Podmiot

Podmiot - nazwa organizacji, środowiska, wydawcy, imię i nazwisko lub powszechnie znany pseudonim osoby, itp. podane w maksymalnie skrótowy, a jednocześnie umożliwiający jednoznaczną identyfikację sposób. W przypadku nazw organizacji i środowisk zaleca się używać powszechnie używanych skrótów, a nie pełnych nazw.

Przykłady:

  • Organizacje:
    • NKS
    • POS
    • Szare Szeregi
  • Środowiska:
    • 16 WDH
    • Czarna Jedynka
  • Wydawcy:
    • NWH
    • Jakobstaf
  • Osoby:
    • Jan Kowalski
    • Kojot

Nazwa

Nazwa - nazwa wydarzenia podana w maksymalnie skrótowy, a jednocześnie umożliwiający jednoznaczną identyfikację sposób.

Przykłady:

  • I Narodowy Zlot ZHP
  • Zlot 70 lecia Harcerstwa
  • Little East Jumbo
  • Jamboree

Opis

Opis - opis obiektu archiwalnego (pliku, podkategorii plikowej) i zbioru obiektów (kategorii) powinien być maksymalnie lapidarny nie dłuższy niż 100 znaków.

W opisie staramy się używać rzeczowników w mianowniku, o ile to nie prowadzi do błędnego zrozumienia, w liczbie pojedynczej. Jest to konwencja ułatwiająca wyszukiwanie haseł przez wyszukiwarkę.

W opisie nie powtarzamy informacji zakodowanych w innej sekcji nazwy. Jeśli nie ma potrzeby umieszczania skróconego opisu w nazwie pliku lub kategorii, należy go pominąć.

Przykłady:

  • Numer Specjalny (dotyczy pisma)
  • Lista osób podpisanych pod listem (dotyczy listu otwartego)
  • Korespondencja Jan Nowak Jan Kowalski Spór o Prawo Harcerskie (dotyczy pojedynczego listu lub zbioru korespondencji)
  • Obóz wędrowny (dotyczy wydarzenia)

Numer pozycji

Niektóre obiekty jak na przykład numery pism i gazet, książki, kroniki, itp. mogą być reprezentowane przez serię skanów zapisanych w wielu plikach.(JPG, jednostronicowy PDF). W celu uporządkowania plików i wyświetlania w odpowiedniej kolejności należy im nadać numer kolejny. W tej sytuacji ponumerowanie plików jest obowiązkowe. Jeśli jednostka archiwalna (kategoria plikowa) składa się wielu obiektów (plików lub podkategorii plikowych) o tych samych nazwach np. seria zdjęć z obozu drużyny nazwanych „1983 Góry Sowie 77 GDH Obóz wędrowny” istnieje konieczność nadania tym plikom unikalnych nazw. Można je więc ponumerować i przy okazji uzyskać kontrolę nad kolejnością ich wyświetlania się. Wtedy numer obiektu w jednostce dodajemy na końcu jego nazwy.

NNN – numerem jest liczba nie poprzedzona żadnym prefiksem będąca ostatnim składnikiem nazwy. Liczby podajemy w zapisie jedno lub kilku cyfrowym w zależności od tego jaka jest całkowita liczba pozycji o tej samej nazwie w danym obiekcie czy jednostce archiwalnej.

  • Zapis jednocyfrowy (N), gdy stron jest 9 lub mniej niż 9.
  • Zapis dwucyfrowy (0N, NN), gdy stron jest 99 lub mniej niż 99.
  • Zapis trzycyfrowy (00N, 0NN, NNN), gdy stron jest 999 lub mniej niż 999.

Ogólne zasady skracania nazw

Nie ma potrzeby powielania informacji zawartych w innej sekcji formatu nazwy.

Np. nazwa:

  • 1973 Kraków Czarna Trzynastka Krakowska Kronika Jubileuszowa Czarnej Trzynastki

jest nieprawidłowa. Wystarczy:

  • 1973 Kraków Czarna Trzynastka Kronika Jubileuszowa (Data Lokalizacja Podmiot Opis)

lub

  • 1973 Kraków Kronika Jubileuszowa Czarnej Trzynastki (Data Lokalizacja Opis)