Development

Documentation/pl_PL/book/formatowanie

You must first sign up to be able to contribute.

Version 8 (modified by kwiateusz, 10 years ago)
--

Standard formatowania dla "The Definitive Guide to symfony"

Standardem formatowania używanym podczas tłumaczenia "The Definitive Guide to symfony" jest Markdown.
Bloki formatowane za pomocą WikiMarkdown obejmujemy w następujący sposób:

{{{
#!WikiMarkdown

}}}

Uwaga: Formatowanie to nie gwarantuje wyglądu w wiki identycznego jak wygląda to w książce. Wygląd tej jest uzyskiwany po transformacji z wiki (w formacie WikiMarkdown) do książki. Dlatego właśnie tak ważne jest zachowanie odpowiedniego formatowania, aby wygląd tłumaczenia był spójny z tym jak wygląda książka oraz inne tłumaczenia.

Poniżej zamieszczam wszystkie konstrukcje stosowane podczas tłumaczenia.

Nagłówki

Wyróżniamy cztery typy nagłówków:

{{{
#!WikiMarkdown

Tytuł rozdziału
===============

Podtytuł
--------

### Nagłówek

#### Najmniej ważny nagłówek

}}}

Najprawdopodobniej ta ilość wystarczy, ponieważ w żadnym miejscu książki nie występują głębiej zagnieżdżone nagłówki.

Formatowanie tekstu

  **pogrubienie**
  *pochylenie*
  ***pogrubienie i pochylenie***

Pokaże:

  • pogrubienie
  • pochylenie
  • pogrubienie i pochylenie

Bloki informacyjne

W tłumaczeniu stosowane są trzy typy bloków informacyjnych:

  • Notatka - oznaczona symbolem http://www.symfony-project.com/images/note.gif
    {{{
    #!WikiMarkdown
    
    >**NOTE**
    > To jest treść notatki. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. 
    Vestibulum neque nisl, aliquam quis, suscipit nec, semper nec, est. Curabitur ut pede ut libero vestibulum luctus. 
    Nullam pede. Donec id dui at lectus convallis tempor. Nulla pede lacus, sodales in, scelerisque et, cursus ac, tortor.
    
    }}}
  • Podpowiedź - oznaczona symbolem http://www.symfony-project.com/images/tip.gif
    {{{
    #!WikiMarkdown
    
    >**TIP**
    > To jest treść podpowiedzi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. 
    Vestibulum neque nisl, aliquam quis, suscipit nec, semper nec, est. Curabitur ut pede ut libero vestibulum luctus. 
    Nullam pede. Donec id dui at lectus convallis tempor. Nulla pede lacus, sodales in, scelerisque et, cursus ac, tortor.
    
    }}}
  • Uwaga - oznaczona symbolem http://www.symfony-project.com/images/caution.gif
    {{{
    #!WikiMarkdown
    
    >**CAUTION**
    > To jest treść uwagi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. 
    Vestibulum neque nisl, aliquam quis, suscipit nec, semper nec, est. Curabitur ut pede ut libero vestibulum luctus. 
    Nullam pede. Donec id dui at lectus convallis tempor. Nulla pede lacus, sodales in, scelerisque et, cursus ac, tortor.
    
    }}}

Ponadto istnieje jeszcze jeden blok określany jako SIDEBAR. Wyróżniony jest on szarym tłem oraz posiada własny tytuł.
Oto przykład:

{{{
#!WikiMarkdown

>**SIDEBAR**
> Tytuł
>
> To jest treść uwagi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. 
> Vestibulum neque nisl, aliquam quis, suscipit nec, semper nec, est. Curabitur ut pede ut libero vestibulum luctus. 
> Nullam pede. Donec id dui at lectus convallis tempor. Nulla pede lacus, sodales in, scelerisque et, cursus ac, tortor.

}}}

Bloki kodów źródłowych

Podczas tłumaczenia często zachodzi konieczność wylistowania kodów źródłowych. Najczęściej są to:

  • Zawartość konsoli/terminala. Aby zamieścić odpowiedni fragment wcinamy tekst (4 spacje):
    {{{
    #!WikiMarkdown
    
        >php -v
    
        PHP 5.2.0 (cli) (built: Nov 2 2006 11:57:36)
        Copyright (c) 1997-2006 The PHP Group
        Zend Engine v2.2.0, Copyright (c) 1998-2006 Zend Technologies
    
    }}}
    Powyższy sposób jest używany również do wstawiania fragmentów plików YAML.
  • Kod źródłowy PHP. Aby zamieścić fragment kodu PHP należy wciąć tekst (4 spacje) i poprzedzić go odpowiednim znacznikiem:
    {{{
    #!WikiMarkdown
    
        [php]
        <?php
     
        $sf_symfony_lib_dir  = '/path/to/symfony/lib/';
        $sf_symfony_data_dir = '/path/to/symfony/data/';
    
    }}}
    Znacznika [php] można używać również do wstawiania fragmentów HTMLa.

Tworzenie linków

  [wp.pl] (http://wp.pl)

Pokaże:

wp.pl