Aktualności | Numer bieżący | Społeczność | Zamówienia | Reklama | Kontakt

Nokia_X2



2_python1



Android



eSwoi



mobileworld24.pl



newsletter




njobs Europe
What:
Where:
Country:
Njobs Netherlands Njobs Deutschland Njobs United Kingdom Njobs Italia Njobs France Njobs Espana Njobs Poland
Njobs Austria Njobs Denmark Njobs Belgium Njobs Czech Republic Njobs Mexico Njobs India Njobs Colombia

  Jedyny w Polsce... » Szukamy autorów » Formatowanie tekstu  

Formatowanie tekstu

Jak formatować teksty?

Artykuły powinny być przesyłane jako pliki tekstowe (w formacie ISO-8859-2 lub UTF-8).

W celu przyspieszenia procesu przygotowania tekstów do druku redakcja "Linux Magazine" stosuje zestaw prostych znaczników (tagów) formatujących. Dzięki temu praca działu DTP przebiega sprawniej, a skład poszczególnych części tekstu nie budzi wątpliwości i jest zgodny z intencjami autora.

Paragrafy

Elementy logiczne artykułu, takie jak tytuły, śródtytuły i właściwy tekst, są rozdzielane przy pomocy znaczników (tagów). Znaczniki są zapisywane w formacie @XX:. Teksty składają się z następujących elementów logicznych:

  • Krótki opis tematu artykułu (nadtytuł) (@D:)
  • Tytuł właściwy (@T:)
  • Wprowadzenie, tzw. lead, czyli tekst pod tytułem (@V:)
  • Właściwy tekst (@L:)
  • Śródtytuły (@ZT:)
  • Ramka z informacjami o autorze wraz z krótkim c.v. (@IT:)

Znaczniki mają charakter otwarty (inaczej niż w HTML-u, gdzie są zawsze zamykane), tzn. formatowanie włączone znacznikiem jest stosowane do momentu napotkania innego znacznika. Zatem znacznik wstawia tylko wtedy, gdy zmienia się format tekstu. Wyjątkiem są paragrafy - ich początek wskazuje znacznik @L:. Aby zaznaczyć początek kolejnego paragrafu, należy ponownie użyć znacznika @L: na początku wiersza.

Artykuły nigdy nie składają się z samego tekstu. Obrazki, rysunki, zrzuty ekranu oraz inne elementy (ramki czy diagramy) pozytywnie wpływają na wygląd materiały. Obrazki, tabele i ramki są elementami ruchomymi i nie można po prostu odwoływać się do nich w tekście słowami "tak jak na zrzucie obok". Zamiast tego rysunki należy wskazywać po numerze, np. "Rysunek 1".

Obrazki

Łatwiej przyswajalna jest informacja wizualna niż werbalna. Rysunki i obrazki powinny ułatwić Czytelnikom zrozumienie trudnej tematyki technicznej. Podczas pisania artykułu warto o tym pamiętać.

Pytanie o format plików rysunków i schematów jest trudne. Dobrym wyborem jest program Xfig - przynajmniej jeśli chodzi o diagramy, wykresy, szkice. Format plików Xfig jest łatwy do przetwarzania (nasi redaktorzy pracują oczywiście w Linuksie) i łatwo jest go przekonwertować do wysokiej jakości Postscriptu. W przypadku użycia innego formatu należy dołączyć zarówno plik w formacie źródłowym, jak i pliki wynikowe PS, EPS lub PDF. Nasz dział DTP często zamienia czcionki i kolory używane w rysunkach i schematach, aby zachować spójność z ogólnym layoutem "Linux Magazine". W przypadku zdjęć optymalne są formaty JPEG i TIFF. W razie wątpliwości warto po prostu zapytać redakcję.

Najlepszymi formatami plików dla zrzutów ekranów są PNG i GIF - zdecydowanie odradzamy JPEG. Podczas tworzenia zrzutu ekranu warto się upewnić, że zawiera on jedynie potrzebny obszar ekranu, by unikać pokazywania pustych miejsc. Kolorystyka powinna być stonowana i estetyczna - pstrokacizna nigdy nie wygląda dobrze w druku. Czcionki - zwłaszcza te pokazywane w menu - nie powinny używać krojów dekoracyjnych; najlepiej wybierać standardowe. Rozmiar zrzutów ekranów nie powinien przekraczać 800 x 600 pikseli.

Rysunki należy opisywać w następujący sposób:

@Bi:fig1.png
@B:Rysunek 1: Jasio po raz pierwszy uruchamia kompilację jądra.

(a jaki jest podekscytowany, wykonując polecenie make ;) )

Odniesienie do rysunku czy zdjęcia powinno dokładnie wskazywać, co ważnego można na nim zobaczyć. Przykład odniesienia do zdjęcia:

@L:Rysunek 1 pokazuje Jasia w czasie kompilacji jądra.

lub:

@L:.....Jasio w czasie kompilacji jądra (Rysunek 1).

Znaczki wyróżniające tekst

Właściwy tekst wskazuje znacznik @L:. Powinien on być stosowany dla wyróżnienia całego paragrafu.

Wyróżnienia tekstu, takie jak pogrubienie czy kursywa, są wskazywane znacznikami w trójkątnych nawiasach, w przeciwieństwie do HTML-a nie są one zamykane znakiem /. Zaznaczamy je jako <I>tekst pochyły<I> i w rzadkich przypadkach <B>pogrubienie<B>. W treści tekstu można również wyróżniać adresy URL za pomocą znacznika <U>, np.: <U>http://www.world.wide.wait.net/index.html<U>. Krótkie polecenia, takie jak np. rm -rf * lub nazwa pliku czy katalogu, powinny być zaznaczone jak tekst pochyły.

Na listing zawierający tylko jedną czy dwie linie koduwskazuje znacznik @LI: w każdej z linii listingu. Listingi są drukowane czcionką o gęstości około 34 znaków w każdym wierszu. Jeśli linia kodu jest dłuższa, należy ją podzielić za pomocą znacznika przełamania linii §§, aby wskazać, że jest to jedna linia logiczna:

@LI:
./configure --with-idea --prefix=/usr --with-rsa

jest zbyt długie, lepiej jest tak:

@LI:
./configure --with-idea --prefix=/usr §§
--with-rsa

Dłuższe listingi należy zamieszczać w ramkach oznaczonych jako Listing. Listingi mogą być dostarczone osobno - poza samym artykułem, ważne, aby były to kompletne listingi i kod źródłowy, ponieważ będą one udostępnione Czytelnikom na naszym serwerze FTP.

Ramki i tabele

Zbyt wiele linii kodu w tekście artykułu czyni go trudnym do czytania. Dlatego kod lepiej umieścić w osobnych ramkach. Oczywiście nie zawsze jest to możliwe, ale jest to najbardziej czytelny sposób.

Ramki zawsze mają własny tytuł wskazywany znacznikiem @KT:. Treść tekstu w ramce poprzedza znacznik @KL:, natomiast listingi w ramkach - @LI:.

@KT:Listing 1: xy.c

@LI:
#include <stdio.h>
...

Oprócz kodu ramki mogą zawierać dodatkowe informacje, takie jak np. słowniczek, wywiad albo po prostu kilka zdań rozwijających pomysł czy opisujących krótko technologię.

Tabele są podobne do zwykłych ramek, ale zaczyna je znacznik @TT:. Poszczególne wiersze tabeli muszą zajmować po jednym wierszu tekstu źródłowego; kolumny rozdziela po prostu pojedynczy tabulator:

@TT:Tabela 1. Porównanie technologii A i B

@TL:Kolumna1 Kolumna2

Sekcja Info zawiera odesłania do literatury i adresy URL do interesujących stron WWW. Jest to po prostu ramka oznaczana znacznikiem @IT:Info. Poszczególne adresy i opisy oddziela znacznik @IL:.

@IT:Info
@IL:
[1] Podręcznik hodowcy pingwinów:
<U>http://www.penguin.org/handbook<U>
[2] Carl Corner, The Kernel - Compiling Made Easy,
"Linux Magazine" numer 22, s. 45.

Nawiasy kwadratowe [1] w tekście odwołują się do przypisu w sekcji Info.

Ramka Autor jest podobna do ramki Info i wygląda następująco:

@IT:Autor
@IL:Jan Ktoś zajmuje się administracją...

Typowe problemy

  • używanie zbyt dużej liczby akronimów (np. PLN, SVG)
  • nadużywanie formy biernej (np. powinno się to w następujący sposób)
  • zbyt częsta zmiana perspektywy, z której prowadzona jest narracja (np. zalecane jest, powinieneś, zalecam, powinniście)
  • zbyt mało rysunków i zrzutów, skrótowe podpisy do rysunków, zrzutów i zdjęć
  • brak śródtytułów dzielących tekst pod względem logicznym
  • używanie formatów plików innych niż ASCII (np. HTML, Latex, Open Office lub Word)

 

In the US and Canada, Linux Magazine is known as Linux Pro Magazine.
Entire contents © 2016 [Linux New Media USA, LLC]
Linux New Media web sites:
North America: [Linux Pro Magazine]
UK/Worldwide: [Linux Magazine]
Germany: [Linux-Magazin] [LinuxUser] [EasyLinux] [Linux-Community] [Linux Technical Review]
Eastern Europe: [Linux Magazine Poland] [Linux Magazine Archive] [Darmowe Programy Poland] [Najlepsze Programy] [Blog.medialinx.pl]
International: [Linux Magazine Spanish]
[Linux Magazine Brazil] [EasyLinux Brazil]
Corporate: [Medialinx AG]