Dodawanie elementu kodu JavaScript

Elementu kodu JavaScript należy użyć dla każdego bloku kodu używanego w szablonie.
Ograniczenie: Ikona nowego składnika Element kodu JavaScript jest dostępny tylko w szablonach w wersji 2.

O tym zadaniu

Kod JavaScript może obejmować zarówno proste argumenty, jak i złożone skrypty.
  • W przypadku prostych argumentów można zastosować skrypt do treści elementu (np. elementu tekstu). Po dwukrotnym kliknięciu elementu tekstu należy wybrać kartę Wyrażenie skryptu i wprowadzić skrypt.
  • W przypadku złożonych skryptów tej czynności można użyć, aby zastosować skrypt przy użyciu elementu kodu JavaScript.
Jeśli zamiast karty Wyrażenie skryptu elementu zostanie użyty element kodu JavaScript, można uzyskać następujące korzyści:
  • Skrypty mogą być ponownie wykorzystywane przez innych użytkowników.
  • Obliczenia można grupować bez brania pod uwagę kolejności ich wykonywania.
  • Możliwe jest tworzenie normalnych i złożonych struktur danych (np. kolekcji) oraz ciągłe dodawanie do nich.
    Wskazówka: Począwszy od wersji Rational Publishing Engine 2.1, można wywołać funkcję zdefiniowaną w jednym elemencie kodu JavaScript w innym elemencie kodu JavaScript lub wyrażeniu skryptu, ustawiając właściwość Skrypt biblioteki w kodzie skryptu. Aby ustawić właściwość Skrypt biblioteki, należy przejść do widoku Właściwości elementu Kod JavaScript, wybrać kartę Konkretne i zaznaczyć pole wyboru Skrypt biblioteki. Więcej informacji o właściwości Skrypt biblioteki można znaleźć w temacie Właściwości elementu kodu JavaScript.

Plik JavaScript utils.js dołączono do plików instalacyjnych oraz predefiniowanych plików komponentu Program budujący dokumenty na potrzeby prostego kodu JavaScript (np. dołączenie bieżącej daty do danych wyjściowych raportu).

Aby wyświetlić listę elementów kodu JavaScript istniejących w szablonie, należy kliknąć opcję Szablon > Przejrzyj kod JavaScript. Zostanie otwarty widok Wyszukiwanie z listą elementów używających kodu JavaScript. W tym kontekście filtry rodzime nie są traktowane jako kod JavaScript. Filtry rodzime nie są wyświetlane w wynikach wyszukiwania.

Procedura

  1. Zapisz szablon przed rozpoczęciem pracy z kodem JavaScript.
  2. W widoku Paleta wybierz element Ikona Kod JavaScript Kod JavaScript i przeciągnij go do edytora treści szablonu.
  3. Kliknij dwukrotnie element kodu JavaScript.
  4. Na karcie Wyrażenie skryptu wybierz w drzewie zmienną, do której ma być zastosowany kod JavaScript.
  5. Wprowadź kod JavaScript, używając jednej z następujących opcji:
    • Wpisz w tym oknie kod ręcznie.
    • Skopiuj i wklej w tym oknie skrypt z poziomu edytora zewnętrznego.
    • Kliknij opcję Dołącz skrypt, a następnie wybierz plik na komputerze, na serwerze zdalnym lub w komponencie Program budujący dokumenty.
  6. Opcjonalne: Po skopiowaniu skryptu z pliku XHTML można:
    • Wybrać opcję Dane wejściowe XHTML, aby umożliwić edytowanie znaczników XHTML zawartych w skrypcie.
    • Usunąć zaznaczenie opcji Dane wejściowe XHTML, aby usunąć ze skryptu wszystkie znaczniki XHTML.
    W przypadku kopiowania tekstu formatowanego lub używania tekstu formatowanego w warunkach, należy wybrać opcję Dane wejściowe XHTML.
    Ważne: Niepoprawny kod XHTML powoduje niepowodzenie generowania dokumentów. Przed zapisaniem zmian należy sprawdzić, czy kod XHTML jest poprawny.
  7. Opcjonalne: W przypadku generowania szablonu do danych wyjściowych XHTML można:
    • Wybrać opcję Dane wyjściowe XHTML, aby przeanalizować skrypt i wyświetlić go jako tekst formatowany.
    • Usunąć zaznaczenie opcji Dane wyjściowe XHTML, aby potraktować skrypt jako zwykły tekst.
    Ten wybór ma zastosowanie do wszystkich atrybutów źródeł danych w wyrażeniu. W jednym skrypcie nie można umieszczać zarówno zwykłego tekstu, jak i tekstu XHTML.

    W przypadku doraźnego kopiowania lub tworzenia tekstu formatowanego konieczne jest wybranie opcji Dane wyjściowe XHTML.

  8. Po wprowadzeniu skryptu kliknij przycisk Testuj skrypt, aby sprawdzić poprawność kodu. Jeśli w kodzie JavaScript są błędy, generowanie dokumentu może się nie zakończyć pomyślnie.
  9. Kliknij przycisk OK, aby zapisać zmiany. Blok kodu zostanie zwinięty w elemencie. Kod można rozwinąć, aby wyświetlić go w edytorze treści szablonu.

Praca w edytorze JavaScript

Edytor JavaScript umożliwia pracę ze skryptem z użyciem funkcji kolorowania składni i aktywnej obsługi treści.

O tym zadaniu

Funkcja kolorowania składni wskazuje, w jaki sposób kod źródłowy JavaScript jest wyświetlany z użyciem określonego dla niego koloru i stylu. Aby zmienić domyślne preferencje kolorowania składni, w aplikacji Document Studio należy wybrać opcję Okna > Preferencje > JavaScript > Edytor > Kolorowanie składni.

Funkcja aktywnej obsługi treści w oknie wywoływanym wyświetla listę poprawnych możliwości dokończenia bieżącego wiersza kodu. Aby aktywować aktywną obsługę treści, należy nacisnąć klawisze Ctrl+spacja.

Zrzut ekranu przedstawiający edytor JavaScript.

Procedura

  1. Kliknij dwukrotnie element kodu JavaScript. Zostanie otwarte okno Wprowadzanie kodu dla elementu kodu JavaScript.
  2. Opcjonalne: Jeśli dołączasz nowy skrypt z innego pliku, kliknij opcję Dołącz skrypt i wybierz plik na komputerze, na serwerze zdalnym lub w komponencie Program budujący dokumenty. Kliknij przycisk OK.

    W przypadku plików wybranych na komputerze lub zdalnym serwerze kopia kodu JavaScript z wybranego pliku zostanie otwarta w edytorze JavaScript.

    W przypadku plików wybranych z komponentu Program budujący dokumenty zostanie otwarte okno Używanie odwołania do skryptu. Należy wybrać, czy kod JavaScript ma zostać dołączony do szablonu jako odsyłacz referencyjny:
    • Jeśli wybierzesz opcję Tak, odsyłacz do kodu JavaScript (.js) zostanie osadzony w znaczniku <Script>. Na przykład poniższy odsyłacz referencyjny zostanie dodany do edytora JavaScript, którego nie można modyfikować:
      <Script src= "library://api/scripts/51"></Script>
      Zapamiętaj: Jeśli uruchamiasz operację generowania dokumentu z poziomu szablonu i masz w szablonie kod JavaScript w postaci odsyłacza referencyjnego, komponent Program budujący dokumenty musi być skonfigurowany i musi mieć nawiązane połączenie z aplikacją Document Studio. Szczegółowe informacje można znaleźć w temacie Nawiązywanie połączenia z komponentem Program budujący dokumenty.
    • Jeśli wybierzesz opcję Nie, kopia kodu JavaScript z wybranego pliku zostanie otwarta w edytorze JavaScript.
  3. Opcjonalne: Kliknij opcję Otwórz w edytorze, aby wprowadzić skrypt w edytorze JavaScript środowiska Eclipse. Skrypt zostanie otwarty na nowej karcie edytora jako tymczasowy plik .js w taki sposób, dzięki czemu będzie można edytować kod JavaScript i zarządzać skryptem za pomocą opcji w widoku Schemat. Po zmodyfikowaniu skryptu zapisz wprowadzone zmiany i zamknij tymczasową kartę edytora JavaScript, aby wrócić do okna Wprowadzanie kodu dla elementu kodu JavaScript.
  4. Kliknij przycisk Testuj skrypt, aby sprawdzić poprawność kodu.
  5. Kliknij przycisk OK, aby zapisać wprowadzone zmiany i zamknąć okno.