Lista slajdów
Lista slajdów jest tworzona automatycznie podczas generowania galerii za pomocą
Kreatora Galerii. Jednak możemy ten plik ręcznie edytować i modyfikować w celu uzyskania dodatkowych (nie możliwych do uzyskania za pomocą wspomnianego wcześniej Kreatora) efektów.
Lista slajdów jest plikiem JavaScript (z rozszerzeniem *.js) i ma następującą składnię
(1)function VG_images(){
this.tab=Array(
slajd 1,
slajd 2,
...
)
}
slajd 1, slajd 2, itd. – są ciągami znaków opisującymi kolejne slajdy.
Zwróćmy uwagę na fakt, że definicje kolejnych slajdów oddzielone są przecinkami, ale po ostatniej definicji przecinka nie ma.
Składnia poszczególnych ciągów opisujących slajdy jest następująca:
(2)"slajd[; slajd_mini;[ link[; opis[; poster[; flagi[; podpowiedzi] ] ] ] ] ]"
Każdy wiersz opisujący poszczególny slajd składa się z maksymalnie siedmiu parametrów oddzielanych średnikami. Każdy z parametrów za wyjątkiem pierwszego może być pominięty.
Jeśli chcemy pominąć któryś z parametrów, ale zastosować następny za nim, to należy użyć dwóch średników bezpośrednio po sobie.
Np. zapis "slajd_1.png;slajd_1.png;;opis" będzie oznaczał, że parametr 3 (link) oraz parametr 5 (poster), szósty (flagi) i siódmy (podpowiedzi) nie będzie wykorzystany.
Ponieważ znakiem rozdzielającym poszczególne parametry jest znak średnika, a znakiem ograniczającym poszczególne ciągi opisujące slajdy jest znak cudzysłowu, to znaki te nie mogą występować wewnątrz parametrów. Gdyby zaistniała potrzeba użycia ich wewnątrz parametrów, to należy znaki te poprzedzić znakiem \. Uwaga ta ma zastosowanie tylko do sytuacji, w której edytujemy ręcznie plik z listą slajdów. Jeśli plik ten jest generowany automatycznie, to
Kreator Galerii zadba o spełnienie powyższego warunku.
Znaczenie poszczególnych parametrów jest następujące:
- Parametr slajd ^
slajd – oznacza nazwę pliku, który będzie slajdem. Slajdem może być zdjęcie, video lub strona internetowa zgodnie z opisem zawartym na karcie
Katalogi i zdjęcia.
Nazwa
slajd może składać się z dwóch nazw połączonych znakiem |. W takiej sytuacji galeria użyje nazwy poprzedzającej znak | jeśli jest uruchomiona w polskiej wersji językowej
lub użyje nazwy zaczynającej się za znakiem |, jeśli uruchomimy galerię w angielskiej wersji językowej.
Popatrzmy na następujący przykład. Mamy cztery zdjęcia:
ver_pl_1.png,
ver_en_1.png i
ver_pl_2.png,
ver_en_2.png. Stwórzmy plik
images_1.js;
(3)function VG_images(){
this.tab=Array(
"ver_pl_1.png | ver_en_1.png",
"ver_pl_2.png | ver_en_2.png"
)
}
oraz najprostszy plik
config_1.js korzystający z powyższego pliku
images_1.js:
(4)function VG_myconfig(){
this.my_file_images="images_1.js";
}
Zakładając, że mamy na stronie div-a z id='gal', poniższe dwa kody otwierają galerię z plikiem konfiguracyjnym
config_1.js w dwóch wersjach językowych (kod 5 – w wersji polskiej, kod 6 – w wersji angielskiej):
(5)
new VG_start(document.getElementById('gal'), 'config_1.js', 0);
(6)
new VG_start(document.getElementById('gal'), 'config_1.js', 1);
Kliknij kod
(5), a potem
(6). Zauważ, że wyświetlany slajd zależy od wybranej wersji językowej.
Jeśli nazwa zawarta w parametrze
slajd nie jest poprzedzona nazwą protokołu (http: lub https:), to plik o podanej nazwie jest szukany
w katalogu wyszczególnionym w
parametrze 5 pliku konfiguracyjnego.
- Parametr slajd_mini ^
slajd_mini – oznacza nazwę pliku, z którego zostanie przygotowana miniatura pliku. Jeśli slajdem jest zdjęcie, to parametr
slajd_mini może być pominięty. W tej sytuacji galeria przygotuje miniaturę ze zdjęcia stanowiącego slajd.
Jeśli slajdem jest video lub strona internetowa, to
slajd_mini musi być podany.
Pozostałe uwarunkowania dotyczące tego parametru są identyczne jak dla parametru
slajd.
- Parametr link ^
link – jest adresem internetowym, do którego nastąpi przekierowanie po kliknięciu w slajd, do którego ten parametr został przypisany.
Przygotujmy przykładowy plik
images_2.js:
(7)function VG_images(){
this.tab=Array(
"ver_pl_1.png | ver_en_1.png;ver_pl_1.png | ver_en_1.png;https://vg.3n.com.pl/vg/examples/ver_pl_1.png | https://vg.3n.com.pl/vg/examples/ver_en_1.png",
"ver_pl_2.png | ver_en_2.png"
)
}
oraz najprostszy plik
config_2.js korzystający z powyższego pliku
images_2.js:
(8)function VG_myconfig(){
this.my_file_images="images_1.js";
this.my_link_mode=1;
this.my_link_permanent= "https://3n.com.pl/pl | https://3n.com.pl/en";
}
i sprawdźmy go w dwóch wersjach językowych tj.:
polskiej i
angielskiej.
Zwróć uwagę, że plik
config_2.js ma ustawiony parametr
my_link_mode na wartość równą 1.
Jeśli parametr ten jest ustawiony na 0, to wszystkie sposoby linkowania dostępne w galerii są wyłączone.
Zwróć też uwagę na parametr
my_link_permanent. Ponieważ w pliku
images_2.js wyszczególniono odnośnik tylko dla pierwszego slajdu,
to slajd drugi linkuje do adresu podanego w tym parametrze (czyli https://3n.com.pl/pl lub https://3n.com.pl/en – w zależności od wersji językowej).
Przygotujmy jeszcze jeden przykładowy plik o nazwie
images_3.js:
(9)function VG_images(){
this.tab=Array(
"ver_pl_1.png | ver_en_1.png;ver_pl_1.png | ver_en_1.png; https://vg.3n.com.pl/vg/examples/ver_pl_1.png,_self | https://vg.3n.com.pl/vg/examples/ver_en_1.png,_blank",
"ver_pl_2.png | ver_en_2.png"
)
}
i jak wyżej sprawdźmy go w dwóch wersjach językowych:
polskiej i
angielskiej.
Zauważ, że w tym przykładzie za adresem strony (po przecinku) wyszczególniono okno, w którym ma zostać otwarty odnośnik (
_self, i
_blank).
Podsumowując – linkowanie w galerii opiera się o następujące założenia:
- Jeżeli parametr 33 w pliku konfiguracyjnym ma wartość 0 lub 3, to wszystkie sposoby linkowania w galerii są wyłączone.
- Jeżeli w pliku konfiguracyjnym parametr 35 lub 36 jest wyszczególniony, to galeria linkuje do nich (przy czym pierwszeństwo ma parametr 36) tylko pod warunkiem nie wyszczególnienia odnośnika przy konkretnym slajdzie.
- Odnośniki wyszczególnione w parametrze 35 lub 36 w pliku konfiguracyjnym oraz odnośniki podane w pliku z listą slajdów mogą kierować do dwóch różnych stron w zależności od wybranej wersji językowej galerii. Aby tak się działo, należy wyszczególnić dwa linki oddzielając je znakiem |.
- Nie ma obowiązku wyszczególniania dwóch linków do dwóch wersji językowych. Jeśli nie chcemy korzystać z tego rozwiązania, to podajemy tylko jeden odnośnik, który zostanie wykorzystany w obu wersjach językowych.
- Za nazwą otwieranej strony – po przecinku – można wyszczególnić nazwę okna, w którym ma zostać otwarty odnośnik. To rozwiązanie nie dotyczy jednak odnośników otwieranych za pomocą parametru 35 lub 36 pliku konfiguracyjnego. W tym wypadku o oknie, w którym odnośnik będzie otwarty decyduje parametr 34.
- Poza omówionymi wyżej sposobami linkowania w galerii, możemy jeszcze wykorzystać specjalny plik z odnośnikami jak to omówiono na stronie Lista odnośników.
- Omówione wyżej założenia dotyczą slajdów, które są zdjęciami oraz w ograniczonym zakresie slajdów, które są filmami. Nie dotyczą natomiast slajdów będących stronami internetowymi. W tym wypadku o właściwe linki należy zadbać właśnie na danej stronie stanowiącej slajd. W przypadku video, odnośniki pracują podobnie jak w przypadku zdjęć za wyjątkiem centralnego pola zajętego przez przycisk uruchamiający odtwarzanie filmu.
- Parametr opis ^
Parametr
opis może zawierać opis konkretnego slajdu. Podobnie jak wyżej możliwe są dwie wersje językowe opisu oddzielone znakiem | (z rozwiązania tego wypływa pewne ograniczenie opisów, otóż nie mogą one zawierać w treści tego właśnie znaku).
Przygotujmy przykładowy plik z opisami o nazwie
images_4.js:
(10)function VG_images(){
this.tab=Array(
"ver_pl_1.png | ver_en_1.png;ver_pl_1.png | ver_en_1.png; https://vg.3n.com.pl/vg/examples/ver_pl.png,_self | https://vg.3n.com.pl/vg/examples/ver_en.png,_blank;Opis slajdu 1, wersja polska | Slide 1 description, english verson",
"ver_pl_2.png | ver_en_2.png;;;Opis slajdu 2, wersja polska | Slide 2 description, english verson"
)
}
Aby ten przykład zadziałał, w pliku konfiguracyjnym musimy uaktywnić pole tekstowe:
(11)function VG_myconfig(){
this.my_file_images="images_4.js";
this.my_link_mode=1;
this.my_link_permanent= "https://3n.com.pl/pl | https://3n.com.pl/en";
this.my_text_field_height=30;
}
Sprawdźmy ten przykład w obu wersjach językowych:
polskiej i
angielskiej.
W tym przykładzie
my_text_field_height=30 oznacza wysokość pola tekstowego, natomiast za adresami stron, jako kolejny parametr, wyszczególniono opisy.
Domyślnym sposobem kodowania znaków w pliku z listą slajdów jest
utf-8. Jeśli z jakichś powodów chcemy użyć innego (niż utf-8) kodowania, to
należy do pliku konfiguracyjnego dodać wpis
my_file_images_charset="kodowanie", gdzie
kodowanie jest nazwą strony kodowej, np.
iso-8859-2.
Więcej na temat opisów w galerii znajdziesz na stronie
Opisy w galerii.
- Parametr poster ^
Parametr
poster dotyczy tylko plików video i definiuje obraz, który będzie wyświetlany przed rozpoczęciem wyświetlania filmu.
Pozostałe uwarunkowania dotyczące tego parametru są identyczne jak dla parametru
slajd (tzn. jest wyszukiwany w tym samym katalogu co pliki stanowiące slajdy oraz może mieć dwie wersje językowe oddzielone znakiem |).
- Parametr flagi ^
Parametr
flagi ma zastosowanie wyłącznie do slajdów, które są zdjęciami i ustala opcjonalnie inne niż domyślne zachowanie slajdu.
Dozwolone wartości flag, to;
1 | – | oznacza, że slajd, który ma taką flagę ma być dodatkowo odsunięty od górnej krawędzi okna o wysokość górnego paska z ikonami. |
16 | – | oznacza, że slajd, który ma taką flagę nie może być powiększany (ale może być pomniejszany) podczas skalowania. |
32 | – | oznacza, że slajd, który ma taką flagę nie może być w ogóle skalowany. |
Wartości jakie może przyjmować ten parametr mogą być łączone bitowo. Tzn. np. wartość 33 oznacza brak skalowania i odsunięcie od górnej krawędzi. Efekty, które można uzyskać za pomocą flag można też uzyskać za pomocą odpowiednich parametrów konfiguracyjnych,
ale użycie flag pozwala ingerować w sposób wyświetlania pojedynczego (konkretnego) slajdu (tzn. np. wszystkie slajdy mogą być skalowane, ale chcemy, aby
jeden konkretny był zawsze wyświetlany w skali 1:1).
- Parametr podpowiedzi ^
Parametr
podpowiedzi zawiera opisy, które będą wyświetlane po naprowadzeniu myszki nad miniaturę slajdu na dolnym pasku z miniaturami lub w panelu miniatur. Aby podpowiedzi te były wyświetlane, należy włączyć odpowiednie opcje w pliku konfiguracyjnym (
parametr 82 i/lub
parametr 83) (zobacz
przykład).
Jeśli parametr
Podpowiedzi nie zostanie wyszczególniony, a wymienione wyżej znaczniki zostaną włączone, to jako podpowiedzi zostaną wykorzystane opisy slajdów (o ile zostały podane).
Parametr
Podpowiedzi może występować w dwóch wersjach językowych. W takim wypadku wersje te oddzielamy znakiem |.
Podpowiedzi zostaną automatycznie dodane do pliku z listą slajdów, jeśli zapiszemy je w pliku tekstowym o nazwie takiej jak slajd, do którego mają być przypisane i plikowi temu dodamy rozszerzenie
.tip.txt. Np. zawartość pliku
slajd_0.tip.txt zostanie automatycznie dodana do slajdu
slajd_0.jpg, jeśli taki slajd będzie istniał. Oba pliki (
slajd_1.jpg i
slajd_1.tip.txt) muszą znajdować się w tym samym katalogu.
Można nadpisać podpowiedzi zawarte w pliku z opisem slajdów poprzez dodanie osobnego
pliku z podpowiedziami i wyszczególnieniu jego nazwy w pliku konfiguracyjnym (
parametr 88).