Σύνταξη Τεκμηρίωσης

Η τεκμηρίωση χρησιμοποιεί Markdown & σύνταξη Texy με ορισμένες επεκτάσεις.

Σύνδεσμοι

Για εσωτερικούς συνδέσμους χρησιμοποιείται η γραφή σε αγκύλες [σύνδεσμος]. Αυτό μπορεί να γίνει είτε με κάθετη γραμμή [κείμενο συνδέσμου |στόχος συνδέσμου], είτε συντομευμένα [κείμενο συνδέσμου], αν ο στόχος είναι ίδιος με το κείμενο (μετά από μετατροπή σε πεζά γράμματα και παύλες):

• [Page name] → <a href="/en/page-name">Page name</a>
• [link text |Page name] → <a href="/en/page-name">link text</a>

Μπορούμε να συνδέσουμε σε άλλη γλωσσική έκδοση ή σε άλλη ενότητα. Ενότητα νοείται η βιβλιοθήκη Nette (π.χ. forms, latte, κ.λπ.) ή ειδικές ενότητες όπως best-practices, quickstart κ.λπ.:

• [cs:Page name] → <a href="/cs/page-name">Page name</a> (ίδια ενότητα, άλλη γλώσσα)
• [tracy:Page name] → <a href="//tracy.nette.org/en/page-name">Page name</a> (άλλη ενότητα, ίδια γλώσσα)
• [tracy:cs:Page name] → <a href="//tracy.nette.org/cs/page-name">Page name</a> (άλλη ενότητα και γλώσσα)

Με τη χρήση του # είναι επίσης δυνατό να στοχεύσουμε σε μια συγκεκριμένη επικεφαλίδα στη σελίδα.

• [#Heading] → <a href="#toc-heading">Heading</a> (επικεφαλίδα στην τρέχουσα σελίδα)
• [Page name#Heading] → <a href="/en/page-name#toc-heading">Page name</a>

Σύνδεσμος στην αρχική σελίδα της ενότητας: (@home είναι μια ειδική έκφραση για την αρχική σελίδα της ενότητας)

• [link text |@home] → <a href="/en/">link text</a>
• [link text |tracy:] → <a href="//tracy.nette.org/en/">link text</a>

Σύνδεσμοι στην Τεκμηρίωση API

Πάντα να τους αναφέρετε μόνο χρησιμοποιώντας αυτή τη γραφή:

• [api:Nette\SmartObject] → Nette\SmartObject
• [api:Nette\Forms\Form::setTranslator()] → Nette\Forms\Form::setTranslator()
• [api:Nette\Forms\Form::$onSubmit] → Nette\Forms\Form::$onSubmit
• [api:Nette\Forms\Form::Required] → Nette\Forms\Form::Required

Χρησιμοποιήστε πλήρως προσδιορισμένα ονόματα μόνο στην πρώτη αναφορά. Για επόμενους συνδέσμους χρησιμοποιήστε το απλοποιημένο όνομα:

• [Form::setTranslator() |api:Nette\Forms\Form::setTranslator()] → Form::setTranslator()

Σύνδεσμοι στην Τεκμηρίωση PHP

• [php:substr] → substr

Πηγαίος Κώδικας

Ένα μπλοκ κώδικα ξεκινά με ```lang και τελειώνει με ```. Οι υποστηριζόμενες γλώσσες είναι php, latte, neon, html, css, js και sql. Για την εσοχή χρησιμοποιείτε πάντα tabulators.

 ```php
	public function renderPage($id)
	{
	}
 ```

Μπορείτε επίσης να αναφέρετε το όνομα του αρχείου ως ```php .{file: ArrayTest.php} και το μπλοκ κώδικα θα αποδοθεί με αυτόν τον τρόπο:

public function renderPage($id)
{
}

Επικεφαλίδες

Την υψηλότερη επικεφαλίδα (δηλαδή τον τίτλο της σελίδας) υπογραμμίστε την με αστερίσκους (***). Για τον διαχωρισμό ενοτήτων χρησιμοποιήστε ίσον (===). Τις υπόλοιπες επικεφαλίδες υπογραμμίστε τις με ίσον (===) και στη συνέχεια με παύλες (---):

Εφαρμογές MVC & Presenters
**************************
...


Δημιουργία Συνδέσμων
====================
...


Σύνδεσμοι στα Templates
-----------------------
...

Πλαίσια και Στυλ

Το perex το επισημαίνουμε με την κλάση .[perex]

Τη σημείωση την επισημαίνουμε με την κλάση .[note]

Τη συμβουλή την επισημαίνουμε με την κλάση .[tip]

Την προειδοποίηση την επισημαίνουμε με την κλάση .[caution]

Μια πιο έντονη προειδοποίηση την επισημαίνουμε με την κλάση .[warning]

Αριθμός έκδοσης .{data-version:2.4.10}

Γράψτε τις κλάσεις πριν από τη γραμμή:

.[perex]
Αυτό είναι το perex.

Παρακαλούμε λάβετε υπόψη ότι τα πλαίσια όπως το .[tip] “τραβούν” τα μάτια, επομένως χρησιμοποιούνται για έμφαση, όχι για λιγότερο σημαντικές πληροφορίες. Γι' αυτό χρησιμοποιήστε τα με τη μέγιστη φειδώ.

Πίνακας Περιεχομένων

Ο πίνακας περιεχομένων (σύνδεσμοι στο δεξί μενού) δημιουργείται αυτόματα για όλες τις σελίδες των οποίων το μέγεθος υπερβαίνει τα 4.000 bytes. Αυτή η προεπιλεγμένη συμπεριφορά μπορεί να τροποποιηθεί χρησιμοποιώντας τα meta tags {{toc}}. Το κείμενο που αποτελεί τα περιεχόμενα λαμβάνεται συνήθως απευθείας από το κείμενο των επικεφαλίδων, αλλά με τον τροποποιητή .{toc} είναι δυνατό να εμφανιστεί στα περιεχόμενα διαφορετικό κείμενο, πράγμα που είναι χρήσιμο κυρίως για μακροσκελείς επικεφαλίδες.

Μακροσκελής και Έξυπνη Επικεφαλίδα .{toc: Οποιοδήποτε άλλο κείμενο εμφανίζεται στα περιεχόμενα}
===============================================================================================

Meta Tags

• Ορισμός προσαρμοσμένου τίτλου σελίδας (στο <title> και στην πλοήγηση breadcrumb) {{title: Άλλος τίτλος}}
• Ανακατεύθυνση {{redirect: pla:cs}} – βλ. Σύνδεσμοι
• Επιβολή {{toc}} ή απενεργοποίηση {{toc: no}} του αυτόματου πίνακα περιεχομένων (πλαίσιο με συνδέσμους στις επιμέρους επικεφαλίδες)