Reguły przygotowywania artykułów do publikacji na stronie TPJWLKP

Data publikacji: 2011.10.18

Reguły przygotowywania artykułów do publikacji na stronie TPJWLKP

Piotr Wrzeciono¹⁾

suigan@op.pl¹⁾

Szkoła Główna Gospodarstwa Wiejskiego w Warszawie, Wydział Zastosowań Informatyki i Matematyki¹⁾,

Wyższa Szkoła Języków Obcych im. Samuela Bogumiła Lindego w Poznaniu²⁾

1. Wprowadzenie

Dnia 14 października 2011 roku Towarzystwo Polsko-Japońskie, Oddział Wielkopolski zmienił serwer, na którym znajduje się strona internetowa organizacji. Obecny jest hostingowany na serwerach home.pl, poprzedni, jeszcze na maszynach republiki.pl, nie mógł już zapewnić wystarczająco dużej wygody aktualizacji. W związku z tym, oprócz przeprowadzki strony na inny serwer i pod nowy adres, pojawił się pomysł, aby przygotować specjalną podstronę przeznaczoną na publikacje dotyczące Japonii i jej kultury. Przyjęto zasadę, że skład strony powinien dokonywać się automatycznie, z minimalną ingerencją w postaci zaznaczenia rozdziałów, podrozdziałów i akapitów. Wspomniane założenie gwarantuje łatwość przenoszenia tekstu publikacji z popularnych edytorów tekstów, takich jak MS Word czy OpenOffice.

Tematyka proponowanych artykułów jest dosyć szeroka, również charakter prac może być różny, począwszy od zagadnień ogólnych, popularyzatorskich, aż do artykułów naukowych. Prace prosimy nadsyłać mailem na adres tpjwlkp@o2.pl. Każda praca przed umiejscowieniem na stronie zostanie wstępnie zrecenzowana. Decyzję o publikacji będziemy przesyłać autorom drogą elektroniczną.

2. Struktura artykułu

Ogólny opis standardu

Tekst artykułu musi zostać umieszczony w pliku tekstowym (rozszerzenie txt). Przyjęto standard kodowania znaków UTF-8, który umożliwia zapis niemalże wszystkich znaków z wielu języków świata. Zatem, jeżeli ktoś chce zamieszczać odniesienia do pozycji japońskojęzycznych, nie musi obawiać się jakichkolwiek problemów z wyświetlaniem znaków zarówno polskich jak i japońskich. Programów do obsługi plików tekstowych jest bardzo wiele, jednym z najbardziej znanych jest tak zwany Notatnik z systemu Windows lub Notatnik++ [1] . Jeżeli ktoś korzysta z systemu linuksowego, może użyć na przykład programu KWrite [2] .

Grafiki mogą być w standardzie png, jpg lub gif, przy czym redakcja strony wyraźnie preferuje pierwszy z wymienionych, ze względu na wierność odwzorowania kolorów. Zdjęcia czy grafiki nie mogą mieć większej rozdzielczości niż 800 punktów w poziomie i 500 punktów w pionie. Rozmiar ten wynika z przyjętych parametrów szerokości strony TPJWLKP.

Tekst artykułu musi znajdować się w jednym pliku tekstowym (rozszerzenie txt). Grafiki należy umieścić w katalogu o tej samej nazwie co plik z publikacją. Całą pracę kompresujemy do pliku ZIP. Utworzone archiwum, zawierające zarówno tekst pracy jak i katalog z ilustracjami przesyłamy na adres Towarzystwa.

Struktura dokumentu

W dokumencie, oprócz tekstu pracy, znajdują się polecenia sterujące, umożliwiające wstawianie rozdziałów, podrozdziałów, grafik i tabel. Dodatkowo można umieszczać linki i literaturę, podobnie jak to ma miejsce w artykułach naukowych. Polecenia sterujące, nazywane dalej tagami, umieszczone są w nawiasach trójkątnych < oraz >. Tagi występują parami, jako znacznik otwierający i zamykający, podobnie jak jest to w HTML. Na przykład tag <rozdział> musi zostać zamknięty tagiem </rozdział>.

Plik tekstowy z artykułem do publikacji musi zawierać następujące znaczniki:

<datapublikacji>,</datapublikacji>

<autor>,</autor>

<afiliacja>,</afiliacja>

<tytuł>,</tytuł>

Kolejność umieszczania powyższych tagów w dokumencie tekstowym nie ma znaczenia, gdyż są one wykorzystywane przez stronę TPJWLKP do generacji listy artykułów oraz nagłówka strony. Jeżeli autor lub autorzy tego chcą, można umieścić własny adres mailowy, jednakże nie jest to konieczne. Adres umieszczamy pomiędzy tagami <mail>,</mail>. Jeżeli autorów jest wielu, adresy mailowe należy podać w takiej samej kolejności, w jakiej są podani autorzy. Dla przykładu, fragment pliku dokumentu tekstowego, z którego wygenerowano ten artykuł wygląda następująco:

<datapublikacji>2011.10.18</datapublikacji>

<autor>Piotr Wrzeciono</autor>

<mail>suigan@op.pl</mail>

<afiliacja>Szkoła Główna Gospodarstwa Wiejskiego w Warszawie,

Wydział Zastosowań Informatyki i Matematyki

</afiliacja>

<tytuł>Reguły przygotowywania artykułów do publikacji na stronie TPJWLKP</tytuł>

Pomiędzy znacznikami umieszcza się określoną informację. Układ jest następujący:

Pomiędzy <datapublikacji> i </datapublikacji> należy wpisać datę ostatecznej redakcji artykułu.

Pomiędzy <autor> i </autor> wpisuje się autora lub autorów publikacji.

Pomiędzy <mail> i </mail> wpisuje się adres mailowy autora lub autorów publikacji.

Pomiędzy <afiliacja> i </afiliacja> wpisuje się afiliację autorów, w takiej samej kolejności jak autorzy.

Pomiędzy <tytuł> i </tytuł> wpisuje się tytuł artykułu.

Uwaga!!! Autorów rozdziela się za pomocą średnika. Również średnik jest używany do rozdzielenia adresów mailowych i afiliacji.

Jak wspomniano wcześniej, w przypadku znaczników używanych do określenia daty publikacji, autorów, ich afiliacji i tytułu, nie ma znaczenia, w jakiej kolejności zostaną umieszczone w pliku tekstowym. Jednakże ze względu na przejrzystość struktury dokumentu, zaleca się, aby te informacje wpisać na samym początku.

Kolejność następnych znaczników jest już istotna, gdyż pełnią one przede wszystkim funkcję formatującą. Pierwszymi znacznikami są <streszczenie> oraz </streszczenie>. Pomiędzy nimi należy umieścić streszczenie artykułu, składające się maksymalnie z 250 słów. Przykładowo, streszczenie tego artykułu wygląda następująco:

<streszczenie>

Niniejsza praca omawia reguły przygotowania artykułu do zamieszczenia na

stronie internetowej Oddziału Wielkopolskiego Towarzystwa Polsko-Japońskiego.

Reguły obejmują standard jakim jest plik tekstowy, kodowanie znaków używane

na stronie, zasady automatycznego składu używane na witrynie Towarzystwa,

oraz reguły umieszczania grafik i tabel. Główną zasadą tworzenia reguł

było ich maksymalnie uproszczenie przy jednoczesnej automatyzacji,

celem znacznego przyspieszenia przygotowywania materiałów na portal tpjwlkp.pl.

</streszczenie>

Nazwa każdego rozdziału artykułu jest pisana czcionką pogrubioną w kolorze niebieskim i z niebieskim podkreśleniem. Zatem, nazwa każdego rozdziału pracy musi znajdować się pomiędzy znacznikami <rozdział> oraz </rozdział>. Tekst umieszczony pomiędzy tymi tagami będzie wyświetlany jako nazwa rozdziału.

Przykład:

<rozdział>2. Struktura artykułu</rozdział>

Nazwa podrozdziału, widoczna jako tekst pogrubiony pisany na czarno, musi znajdować się pomiędzy znacznikami <podrozdział>Struktura artykułu</podrozdział>

Przykład:

<podrozdział>Ogólny opis standardu</podrozdział>

Akapit tekstu umieszcza się pomiędzy znacznikami <tekst> oraz </tekst>.

Przykład:

<tekst>

Rozpoczął się nowy akapit. Jeszcze nie wiem, co mam napisać, ale już coś jest.

</tekst>

3. Grafika w artykule

Jak wspomniano wcześniej, grafikę należy umieścić w osobnym podkatalogu, najlepiej o takiej samej nazwie jak plik z artykułem. Warunek odnośnie nazw katalogu i pliku nie musi być bezwzględnie spełniony, jednakże przy takim rozwiązaniu, łatwiej się zorientować, jakie grafiki przypisane są do konkretnego dokumentu.

Do umieszczania ilustracji używa się znaczników:

<grafika_lewa> i </grafika_lewa> jeżeli chcemy, żeby grafika znajdowała się z lewej strony i była opływana tekstem z prawej strony,

<grafika_prawa> i </grafika_prawa> jeżeli chcemy, żeby grafika znajdowała się z prawej strony i była opływana tekstem z lewej strony,

<grafika_środek> i </grafika_środek> jeżeli grafika ma być wycentrowana, bez opływania.

Nazwę pliku podaje się pomiędzy znacznikami <plik_grafika> i </plik_grafika>. Nazwa pliku musi być podana bez dodawania jakichkolwiek spacji. Podpis pod grafiką podaje się pomiędzy tagami <podpis> <podpis/>.

Przykład:

Grafika umieszczona po prawej stronie, tekst opływający po lewej stronie:

4. Tabele w artykule

W niektórych publikacjach wskazane jest wstawienie tabel. Celem maksymalnego uproszczenia tego zadania, opracowano znaczniki sterujące specjalnie do tabeli.

Tabelę rozpoczyna znacznik <tabela>, a kończy się ją za pomocą znacznika </tabela> . Wiersze tabeli umieszcza się pomiędzy tagami <wiersz> oraz </wiersz> . Zawartość komórek nagłówka tabeli wpisuje się pomiędzy znaczniki <nagłówek> oraz </nagłówek>. Zawartość pozostałych komórek wpisuje się pomiędzy tagi <komórka> oraz </komórka>. Pod tabelą należy wpisać jej opis, wstawiając właściwy tekst pomiędzy znaczniki <podpis_tabela> i <podpis_tabela>. Uwaga! Każdy wiersz tabeli musi mieć tą samą liczbę komórek!!!!! Przykład:

Tekst, z którego powyższe cytowanie zostało utworzone, wygląda następująco:

<cytowanie_polskie>

Kiedy mieszkałem w Kioto, dwa razy udało mi się wziąć udział w święcie Mitarashi shintoistycznego

chramu Shimogamo jinja. Mitarashi, święto Czcigodnego Mycia Rąk, odbywa się corocznie w ciągu kilku

letnich dni. W 2005 roku trwało od 28 do 30 lipca, przy czym zgodnie z ponad tysiącletnią tradycją

wybiera się dzień Krowy w starym japońskim kalendarzu.

</cytowanie_polskie>

Cytowanie japońskich tekstów

W razie zaistnienia potrzeby cytowania obszernego fragmentu tekstu japońskiego, należy go umieścić pomiędzy znacznikami <cytowanie_japońskie> oraz </cytowanie_japońskie>. Rozróżnianie cytowań polskich i japońskich jest konieczne, gdyż w przypadku każdego z rodzajów pisma, obowiązują trochę inne reguły poprawnego składu. Na przykład nie należy używać kursywy podczas pisania po japońsku. Również wielkość japońskich znaków musi być nieco większa od polskich.

Poniżej zamieszczono przykładowy tekst [5] pisany po japońsku.

7. Dodatkowe uwagi

Ponieważ wszystkie znaczniki bazują na języku HTML, można również używać w artykule innych, nie zdefiniowanych bezpośrednio w kodzie strony Towarzystwa. Do najbardziej użytecznych należy zaliczyć:

Złamanie linii: <br/>

Pogrubienie tekstu: <b> oraz </b>. Oczywiście pogrubiony zostanie tekst pomiędzy tagami.

Pochylenie tekstu: <i> oraz </i>

Indeks górny: ^oraz

Indeks dolny: _oraz

Znaczników HTML formatujących tekst jest znacznie więcej, jednakże w artykule należy je ograniczyć do minimum, skupiając się na użyciu tych zdefiniowanych specjalnie dla strony. Należy pamiętać, że system rozróżnia duże i małe litery. Wszystkie znaczniki używane w artykule pisane są w całości małymi literami! Dodatkowo, w przypadku znaczników ze strony, nie wolno dopisywać dodatkowych spacji! Dopisanie dodatkowych spacji czy też ręczne będzie skutkować brakiem formatowania na stronie www.

Oczywiście istnieje też możliwość nadesłania artykułu w standardowym formacie doc, docx lub odt. Wtedy jednak czas oczekiwania na umieszczenie artykułu na stronie Towarzystwa będzie dłuższy, gdyż oprócz przeczytania i zrecenzowania Państwa publikacji, będzie trzeba jeszcze przenieść go do standardu obowiązującego na naszej stronie. W przypadku pisania artykułu w klasycznym edytorze tekstów, należy pamiętać o wyraźnym podziale na rozdziały, podrozdziały oraz bibliografię. Oczywiście nie można również zapomnieć o afiliacji autorów.

Zatem jeszcze raz zachęcamy do publikowania swoich prac na stronach Wielkopolskiego Oddziału Towarzystwa Polsko-Japońskiego.

Bibliografia

1. Program Notatnik ++, adres www: http://notepad-plus-plus.org/

2. Program KWrite, adres www: http://www.kde.org/applications/utilities/kwrite/

3. Aikido dla dzieci, adres www: http://aikidodladzieci.blogspot.com/2010/10/rysujemy-mange-zajecia-2-kokeshi.html

4. Kanert Maciej, Starożytna Japonia, Wydawnictwo Uniwersytetu Jagiellońskiego, Kraków 2006, str. 7

5. 赤石・路代、「永遠かもしれない（１）」、小学館文庫、２００３年