Podręcznik użytkownika

Copyright © 2010-2015. Ten dokument jest chroniony prawem autorskim. Lista autorów znajduje się poniżej. Możesz go rozpowszechniać oraz modyfikować na zasadach określonych w General Public License (http://www.gnu.org/licenses/gpl.html), wersja 3 lub późniejsza, albo określonych w Creative Commons Attribution License (http://creativecommons.org/licenses/by/3.0/), wersja 3.0 lub późniejsza.

Współtwórcy

Jean-Pierre Charras.

Tłumaczenie

Kerusey Karyu <keruseykaryu@o2.pl>, 2014-2015.

Kontakt

Please direct any bug reports, suggestions or new versions to here:

Data publikacji i wersja oprogramowania

23 Maj 2015.

1. Wprowadzenie do programu Pl_Editor

Pl_Editor to narzędzie do tworzenia własnych układów stron oraz bloków tytułowych.

The title block, associated to frame references, and other graphic items (logos) is called here a page layout.

Podstawowymi elementami składowymi są:

  • Linie

  • Prostokąty

  • Teksty (z formatowaniem symbolicznym pół, które zostaną zastąpione przez rzeczywistą zawartość, taką jak data czy numer strony) które dostarcza Eeschema lub Pcbnew.

  • Wypełnione wielokąty (głównie przeznaczone do tworzenia kształtów grafiki).

  • Bitmapy.

Ostrzeżenie
Bitmapy mogą być rysowane tylko przez kilka modeli ploterów (tylko PDF i PS). Dlatego, dla pozostałych ploterów, rysowana będzie tylko krawędź brzegowa takich elementów.
  • Wszystkie te elementy mogą zostać automatycznie powielane, a teksty i linie łamane mogą również zostać przekształcane przez obrót.

2. Pliki obsługiwane przez Pl_Editor

2.1. Pliki wejściowe i domyślny plik układu strony

Pl_Editor odczytuje lub zapisuje pliki z definicjami układu strony *.kicad_wks (KiCad Worksheet).

An internal default page layout description to display the default KiCad title block is used until a file is read.

2.2. Pliki wyjściowe

Obecnie plik definicji układu strony może zostać zapisany jako *.kicad_wks, z użyciem formatu S-expression, który jest już szeroko używanym formatem zapisu danych w programie KiCad.

Plik ten może być później użyty w programach Eeschema i/lub Pcbnew jako własny układ strony.

3. Działanie programu

3.1. Podstawowe elementy układu strony:

Podstawowymi elementami składowymi są:

  • Linie

  • Prostokąty

  • Teksty (z formatowaniem symbolicznym pół, które zostaną zastąpione przez rzeczywistą zawartość, taką jak data czy numer strony) które dostarcza Eeschema lub Pcbnew.

  • Wypełnione wielokąty (głównie przeznaczone do tworzenia kształtów grafiki) tworzone przez Bitmap2component. Nie było możliwe wbudowanie ich tworzenia w programie Pl_editor, ponieważ skomplikowane kształty byłyby bardzo trudne do ręcznego odwzorowania prostymi narzędziami.

  • Bitmapy przeznaczone do umieszczania logotypów.

Ostrzeżenie
Bitmapy mogą być rysowane tylko poprzez kilka modeli ploterów: wspierających PDF oraz PS.

Jednakże:

  • Teksty, wypełnione wielokąty oraz bitmapy są definiowane poprzez ich pozycję i mogą być obracane.

  • Lines (in fact segments) and rectangles are defined by two points: a start point and a end point. They cannot be rotated (this is useless for segments).

Wszystkie elementy można automatycznie powtarzać.

Texts which are repeated accept also an increment value for labels (has meaning only if the text is one letter or one digit).

3.2. Układ współrzędnych

Każda pozycja, czy punkt początkowy czy końcowy, jest zawsze względna wobec narożnika strony.

Ta funkcjonalność pozwala na definiowanie układów strony niezależnie od rozmiaru papieru.

3.3. Punkty bazowe i pozycje elementów

images/pl/page_property_1.png

  • Gdy zmienia się rozmiar strony, pozycja elementu określona względem punktu bazowego (jednego z narożników) się nie zmienia.

  • Zwykle tabliczki tytułowe są wyrównane do prawego dolnego narożnika i ten narożnik jest dla nich punktem bazowym, zatem wszelkie elementy składowe ramki są ułożone tak samo niezależnie od rozmiaru strony.

Dla prostokątów i segmentów, które posiadają dwa punkty zaczepienia, każdy punkt ma swój punkt bazowy.

3.4. Rotacja elementów

Elementy których pozycja określana jest przez jeden punkt (teksty lub wypełnione wielokąty) można obracać względem tego punktu:

Normal: Rotation = 0

images/en/text_noriented.png

Rotated: Rotation = 20 and 10 degrees.

images/en/text_rotated.png

3.5. Elementy powtarzalne

Elementy składowe ramek można powtarzać.

Jest to użyteczne do tworzenia siatek oraz ramek podzielonych na pola.

scaledwidth=

4. Tekst i formatowanie

4.1. Symbole formatowania pól

Teksty mogą być prostymi ciągami lub też zawierać symbole formatowania pól.

Symbole formatowania zostaną zastąpione przez ich wartości pobrane ze zmiennych Eeschema lub Pcbnew.

Formatowanie przypomina składnię formatowania funkcji printf() w języku C.

Symbole formatowania składają się ze znaku % połączonego z literą kodową.

The %C format has one digit (comment identifier).

Poszczególne symbole formatowania pól oznaczają:

%% = zamieniany na znak %

%K = wersja programu KiCad

%Z = nazwa formatu papieru (A4, USLetter …)

%Y = pole Firma z ustawień strony

%D = pole Data z ustawień strony

%R = pole Rewizja z ustawień strony

%S = numer arkusza

%N = liczba arkuszy

%Cx = pole Komentarz z ustawień strony (x = 0…9 określa numer komentarza)

%F = nazwa pliku

%P = nazwa ścieżki do pliku (nazwa arkusza w przypadku Eeschema)

%T = pole Tytuł z ustawień strony

Przykładowo:

“Rozmiar: %Z” wyświetli “Rozmiar: A4” lub “Rozmiar: USLetter”

User display mode: images/icons/pagelayout_normal_view_mode.png activated. Title block displayed like in Eeschema and Pcbnew

images/en/show_fields_data.png

"Native" display mode: images/icons/pagelayout_special_view_mode.png activated. The native texts entered in Pl_Editor, with their format symbols.

images/en/show_fields_codes.png

4.2. Teksty złożone z wielu linii

Teksty w układzie strony mogą również zawierać wiele linii.

Istnieją dwie możliwości ich wprowadzania:

  1. Insert the "\n" 2 chars sequence (mainly in Page setup dialog in KiCad).

  2. Można w prawym panelu przy zaznaczonym obiekcie tekstowym w jego polu Tekst wprowadzić tekst z przejściami do nowej linii.

Poniżej znajduje się przykład tekstu składającego się z wielu linii.

Setup

images/en/options_multi_line.png

Output

images/en/multi_line.png

4.3. Teksty złożone z wielu linii w ustawieniach strony

W ustawieniach strony, pola do wpisywania tekstu nie pozwalają na swobodną edycję tekstu i prowadzanie kilku linijek tekstu nie jest akceptowane.

The "\n" 2 chars sequence should be inserted to force a new line inside a text.

Poniżej znajduje się przykład tekstu w polu Komentarz 2, który zostanie wyświetlony w dwóch liniach:

images/pl/insert_newline_code.png

Tak wprowadzony tekst zostanie wyświetlony:

images/pl/multi_line_2.png

However, if you really want the "\n" inside the text, enter "\\n".

images/pl/insert_slashnewline_code.png

Wtedy taki tekst zostanie wyświetlony w jednej linii, a znak przejścia do nowej linii nie zostanie błędnie zinterpretowany:

images/pl/multi_line_3.png

5. Teksty w ograniczonym polu

5.1. Elementy widoczne na poszczególnych stronach

Używając Eeschema, pełny schemat często nie mieści się na jednej stronie i jest podzielony hierarchicznie na klika arkuszy.

W takim przypadku wszystkie elementy układu strony są wyświetlane na kolejnych arkuszach.

But if a user want some items to be displayed only on page 1, or not on page 1, the "page 1 option" this is possible by setting this option:

images/en/display_options.png

Page 1 option:

  • None: no constraint.

  • Page 1 only: the items is visible only on page 1.

  • Not on page 1: the items is visible on all pages but the page 1.

5.2. Teksty w ograniczonym polu

images/pl/constraint_options.png

Teksty mogą posiadać ograniczenia co do zajmowanego miejsca. Dlatego jako jedyne mają dodatkowe 2 parametry:

  • Maksymalna wielkość X,

  • Maksymalna wielkość Y,

which define a bounding box.

Kiedy opcje te nie będą ustawione na zero, wtedy podczas wyświetlania tekstu, bieżąca wielkość lub szerokość zostanie automatycznie i dynamicznie ograniczona, tak by cały tekst zmieścił się w określonych ramach.

Oczywiście jeśli tekst będzie mniejszy niż określone ramy nie będzie on skalowany.

The text with no bounding box. Max size X = 0,0 Max size Y = 0,0

images/en/constraints_none.png

The same text with constraint. Max size X = 40,0 Max size Y = 0,0

images/en/constraints_defined.png

Ograniczenie pola dla tekstu można też zastosować do tekstów składających się z wielu linii:

Setup

images/pl/constraint_options.png

Output

images/en/block_constraints.png

6. Uruchamianie

Pl_Editor zwykle uruchamiany jest przez Menedżera projektu KiCad albo poprzez linię poleceń.

W przypadku linii poleceń składnia jest standardowa: pl_editor <plik *.kicad_wks>.

7. Obsługa programu

7.1. Ekran główny

Poniższy obrazek ukazuje pełne okno programu Pl_Editor:

images/en/main_window.png

Lewy panel gdzie znajduje się lista elementów składowych układu strony. Zamiast wybierać element za pomocą myszy, klikając w obszarze roboczym, można go wybrać z tej listy. W przypadku elementów niewidocznych może to być jedyny sposób ich wyboru.

Prawy panel gdzie znajdują się właściwości danego elementu, które można dostosować lub zmienić.

7.2. Menu główne

images/pl/main_toolbar.png

Znaczenie poszczególnych przycisków jest następujące:

images/icons/pagelayout_new.png

Select the net list file to be processed.

images/icons/pagelayout_load.png

Load a page layout description file.

images/icons/save.png

Save the current page layout description in a .kicad_wks file.

images/icons/sheetset.png

Display the page size selector and the title block user data editor.

images/icons/print_button.png

Prints the current page.

images/icons/delete.png

Delete the currently selected item.

images/icons/undo.png images/icons/redo.png

Undo/redo tools.

images/icons/zoom_in.png images/icons/zoom_out.png images/icons/zoom_redraw.png images/icons/zoom_fit_in_page.png

Zoom in, out, redraw and auto, respectively.

images/icons/pagelayout_normal_view_mode.png

Show the page layout in user mode: texts are shown like in Eeschema or Pcbnew: text format symbols are replaced by the user texts.

images/icons/pagelayout_special_view_mode.png

Show the page layout in native mode: texts are displayed "as is", with the contained formats, without any replacement.

images/en/set_base_corner.png

Reference corner selection, for coordinates displayed to the status bar.

images/en/set_current_page.png

Selection of the page number (page & or other pages).

This selection has meaning only if some items than have a page option, are not shown on all pages (in a schematic for instance, which contains more than one page).

7.3. Polecenia w oknie edycji

7.3.1. Polecenia wydawane z klawiatury

F1

Przybliżanie widoku.

F2

Oddalanie widoki.

F3

Odświeżenie widoku.

F4

Przesunięcie kursora na środek obszaru roboczego razem z przesunięciem widoku.

Home

Dopasowanie powiększenia widoku by pełny układ strony zmieścił się w obszarze roboczym.

Space Bar

Ustawienie punktu bazowego dla współrzędnych względnych wyświetlanych na pasku statusu.

Strzałka w prawo

Przesunięcie kursora o jedną pozycję siatki w prawo.

Strzałka w lewo

Przesunięcie kursora o jedną pozycję siatki w lewon.

Strzałka w górę

Przesunięcie kursora o jedną pozycję siatki w górę.

Strzałka w dół

Przesunięcie kursora o jedną pozycję siatki w dół.

7.3.2. Polecenia związane z myszą

Kółko myszy

Przybliżanie lub oddalanie widoku w danym punkcie.

Ctrl + Kółko myszy

Przesuwanie widoku w prawo lub lewo z zachowaniem pozycji kursora.

Shift + Kółko myszy

Przesuwanie widoku w górę lub w dół z zachowaniem pozycji kursora.

Kliknięcie lewym klawiszem myszy

Wybór elementu na ekranie.

Kliknięcie prawym klawiszem myszy

Otwarcie menu kontekstowego dla elementu, nad którym znajduje się kursor.

7.3.3. Menu kontekstowe

Menu kontekstowe jest zmienne w zależności od miejsca gdzie aktualnie znajduje się kursor. Domyślnie zawiera podstawowe polecenia. Po wybraniu jednego z elementów dostępne są dodatkowe polecenia.

  • Dodaj linię

  • Dodaj prostokąt

  • Dodaj tekst

  • Importuj plik z definicją linii łamanej

służą do umieszczania na obszarze roboczym elementów składowych układu strony.

  • Wybór powiększenia: bezpośredni wybór stopnia powiększenia.

  • Wybór siatki: bezpośredni wybór skoku siatki.

Zapamiętaj

Importuj plik z definicją linii łamanej jest przeznaczony do umieszczenia na układzie strony złożonych linii łamanych np. logotypów.

Nie jest możliwe dodanie klasycznej linii łamanej, gdyż wymaga ona zwykle kilku lub kilkunastu punktów, co nie jest obecnie obsługiwane. Linie takie w postacie wypełnionych obszarów można zaimportować z plików tworzonych przez Bitmap2Component.

7.4. Pasek stanu

The status bar is located at the bottom of the Pl_Editor and provides useful information to the user.

images/en/pl_status_bar.png

Należy pamiętać, że współrzędne są zawsze podawane jako względne w stosunku do wybranego punktu bazowego.

8. Panel lewy

Panel lewy pokazuje pełną listę elementów składających się na układ strony.

Kliknięcie prawym klawiszem na liście wybiera wskazany element i jego właściwości pojawiają się automatycznie w prawym panelu. Dodatkowo kliknięcie prawym klawiszem otworzy skrócone menu kontekstowe.

Pozwala ono na proste operacje jak dodanie nowego elementu, czy też jego usunięcie.

  • → Wybrany element został automatycznie podświetlony w oknie edycji.**

Design tree: the item 19 is selected, and shown in highlighted on the draw panel.

images/en/project_tree.png

9. Panel prawy

Prawe okno jest oknem edycji.

images/en/property_none.png

images/en/property_main.png

W tym oknie dialogowym można ustawić właściwości strony oraz właściwości elementu aktualnie wybranego.

Wyświetla właściwości danego elementu w zależności od jego typu:

Ustawienia dla linii oraz prostokątów

Ustawienia dla tekstów

images/en/property_line.png

images/en/property_text.png

Ustawienia dla złożonych linii łamanych

Ustawienia dla bitmap

images/en/property_polyline.png

images/en/property_bitmap.png

10. Edycja istniejących elementów

10.1. Wybór elementu

Edytowany element może zostać wybrany poprzez:

  • Drzewo projektu,

  • Klikając na niego z wykorzystaniem lewego klawisza myszy w obszarze roboczym,

  • Klikając na niego z wykorzystaniem prawego klawisza myszy w obszarze roboczym. Zostanie dodatkowo wyświetlone menu kontekstowe.

Gdy element zostanie wybrany, to zmieni się jego kolor wyświetlany w obszarze roboczym.

images/edit_line.png

The starting point ( images/edit_line_start.png ) and the ending point ( images/edit_line_end.png ) are highlighted.

Kliknięcie prawym klawiszem będzie wywoływać odpowiednie menu kontekstowe:

Menu to będzie się zmieniać w zależności od wybranego elementu:

images/en/context_line_move_start.png

images/en/context_line_move_end.png

images/en/context_line_move.png

Jeśli z miejscu kliknięcia będzie więcej niż jeden element to Pl_Editor wyświetli dodatkowe okno pozwalające wybrać właściwy element:

images/en/dialog_select_element.png

images/drag_element.png

Once selected, the item, or one of its end points, can be moved by moving the mouse and placed (right clicking on the mouse).

10.2. Tworzenie nowych elementów

Aby dodać nowy element należy skorzystać z menu kontekstowego. Można go wywołać zarówno gdy kursor znajduje się na lewym panelu z drzewem projektu, jak i w obszarze roboczym.

Przy czym oba wywołania będą się różnić, ale podstawowe polecenia związane z tworzeniem nowych elementów zostaną takie same:

Pop up menu in left window

images/en/context_createnew.png

Pop up menu in draw area.

images/en/context_createnew2.png

Linie, prostokąty czy tekst są dodawane bezpośrednio poprzez wybranie odpowiedniego polecenia z menu kontekstowego.

Grafika, np. logotyp należy wcześniej przetworzyć w programie Bitmap2component na postać krzywych i wypełnień.

The Append Page Layout Descr File option append this file, to insert the logo (a poly polygon).

10.3. Tworzenie linii, prostokątów i tekstów

Kliknięcie na jedno z poleceń wstawiania linii, prostokątów lub tekstów otworzy okno dialogowe z jego opcjami:

Adding line or rectangle

images/en/dialog_newline.png

Adding text

images/en/dialog_newtext.png

Z pomocą tych okien można wstępnie określić pozycję punktów początkowych, końcowych bądź narożników.

Jednakże można to zrobić później korzystając z właściwości obiektów znajdujących się na prawym panelu, albo skorzystać z możliwości ich edycji w polu roboczym.

W większości przypadków punkty początkowe odnoszą się do tego samego punktu bazowego siatki.

Jeśli w danym przypadku tak nie jest, określenie punktu bazowego lepiej jest wykonać już na etapie tworzenia, ponieważ jeśli punkt bazowy zostanie później zmieniony, geometria elementu będzie nieco dziwna.

Gdy element zostanie już stworzony, będzie go można dokładniej przesunąć w obszarze roboczym by umieścić go na właściwym miejscu (jest to bardzo użyteczne w przypadku tekstów oraz małych linii lub prostokątów).

10.4. Tworzenie grafiki (logotypów)

By dodać logotyp - linię łamaną (czyli wektorową postać logotypu) należy go najpierw stworzyć używając Bitmap2component.

Program ten tworzy też pliki z definicjami linii łamanych, które można dołączyć do bieżącego projektu wywołując polecenie Importuj plik z definicją linii łamanej.

Plik utworzony przez Bitmap2component to zwykły plik układu strony, ale zawierający wyłącznie jeden element: wypełniona, zamknięta linia łamana.

However, this command can be used to append any page layout description file, which is merged with the current design.

Po wstawieniu grafiki, można ją przesunąć w docelowe miejsce i zmienić jej parametry, np. obrócić czy powielić tak jak inne elementy układu strony.

10.5. Dodawanie obrazów z map bitowych

You can add an image bitmap using most of bitmap formats (PNG, JPEG, BMP …).

  • When a bitmap is imported, its PPI (pixel per inch) definition is set to 300PPI.

  • Wartość tą można zmienić na prawym panelu w opcji Rozdzielczość (prawy panel).

  • Rozmiar bitmapy na rysunku jest zależny od tego parametru.

  • Należy być ostrożnym przy umieszczaniu map bitowych o dużej rozdzielczości, ponieważ zwiększają one znacznie rozmiar pliku. Ponadto zwiększają one czas potrzebny na przerysowanie ramki.

Bitmapy mogą być powtarzane, lecz nie można ich obracać.