Βοήθεια:Style

Μετάβαση σε: πλοήγηση, αναζήτηση
Wiki> Κατευθυντήριες γραμμές περιεχομένου
Οι Κατευθυντήριες γραμμές σχετικά με τη μορφή καλύπτουν τα βασικά στο πώς να δημιουργήσετε ή να επεξεργαστείτε άρθρα διασφαλίζοντας μια συνεπή όψη και αίσθηση συνολικά. Βασίζονται σε παρόμοιες κατευθυντήριες γραμμές της Wikipedia. Οι ακόλουθες συμπεριλαμβάνουν αναλυτικές πληροφορίες για τη μορφή των άρθρων στο openSUSE wiki.

Γενική χρηστικότητα

Ουδέτερη μορφή

Χρησιμοποιήστε ένα ουδέτερο στυλ γραφής. Αποφύγετε τη χρήση των προσωπικών αντωνυμιών "εγώ", "εμείς", κλπ.

Κρατήστε το σύντομο και περιεκτικό

Κατά τη συγγραφή, λάβετε υπόψη το πώς εσείς αποφασίζετε να συνεχίσετε ή όχι την ανάγνωση. Φτωχικά γραμμένα, ή πολύλογα άρθρα δε θα αναγνωστούν.

  • Μην προσθέτετε άσχετο ή περιττό περιεχόμενο. Ο κόσμος διαβάζει σύντομα, ξεκάθαρα άρθρα που δίνουν την επιθυμητή πληροφορία. Αποφεύγει όμως τα φλύαρα άρθρα με άσχετο περιεχόμενο
  • Χρησιμοποιήστε μια συνεπή, μη-σωριασμένη μορφή από πάνω ως κάτω. Κανείς δε θα διαβάσει ένα μακρόσυρτο άρθρο σπασμένο σε τμήματα μέσω αταίριαστων διατάξεων ή χρωμάτων. Αυτά απλά επιβραδύνουν την ανάγνωση και απομακρύνουν τον αναγνώστη.
  • Για να κάνετε το άρθρο σας χρήσιμο και διάσημο, κρατήστε το σύντομο και περιεκτικό!

Δείτε την ανάπτυξη Άρθρων στη Wikipedia.

Δομή

Τίτλος

  • Ο τίτλος πρέπει να είναι ξεκάθαρος και σύντομος. Δείτε Παραδείγματα κακών τίτλων άρθρων
  • Μη χρησιμοποιείτε κρυπτογραφικά Ακρωνύμια, εκτός κι αν είστε σίγουροι ότι είναι ευρέως γνωστά από το κοινό που στοχεύετε.
  • Μη χρησιμοποιείτε γραφή τύπου CamelCase (μεΕνδιάμεσαΚεφαλαία). Αντί αυτού, χρησιμοποιήστε κενά.
  • Χρησιμοποιήστε το ίδιο στυλ κεφαλαίων όπως στη Wikipedia.
  • Μη χρησιμοποιείτε άνω και κάτω τελεία ως διαχωριστικό σε τίτλους, καθώς χρησιμοποιείται για να ορίσει ένα χώρο ονομάτων στο MediaWiki.
  • Αποφύγετε τη χρήση ειδικών χαρακτήρων. Χρησιμοποιήστε μόνο τους χαρακτήρες [Aa-Zz] [0-9].

Τίτλος τμήματος

  • Όλες οι παραπάνω οδηγίες εφαρμόζονται επίσης και στους τίτλους τμημάτων.
  • Αφού οι τίτλοι τμημάτων σχηματίζουν τον πίνακα περιεχομένων, ένα σύντομο τηλεγραφικό στυλ βοηθά την αναγνωσιμότητα και την πλοήγηση στη σελίδα.
  • Μην επαναλαμβάνετε τον τίτλο του άρθρου στο πρώτο τμήμα. Ο πλεονασμός δεν ενθαρρύνει την περαιτέρω ανάγνωση.
  • Μη χρησιμοποιείτε το Σχετικά ή Εισαγωγή ως όνομα του πρώτου τμήματος. Το πρώτο τμήμα κάθε άρθρου είναι η εισαγωγή σε ένα θέμα, οπότε η ρητή αναφορά του δε φέρνει κάτι καινούριο στον αναγνώστη.

Κεφαλίδες

  • Χρησιμοποιήστε τη σήμανση = για να δημιουργήσετε μια κεφαλίδα. Κατ' αυτόν τον τρόπο, ο πίνακας περιεχομένων δημιουργείται αυτόματα από τις κεφαλίδες και βοηθά τους αναγνώστες να μετακινηθούν απευθείας στο κομμάτι που τους ενδιαφέρει.
  • Ξεκινήστε με διπλό ίσον == όχι με μονό =.
Icon-forbidden.pngΑπαγορευμένο Μονό ίσον (=) παράγει το ίδιο μέγεθος κειμένου με τον τίτλο του άρθρου, κάτι το οποίο δε χρησιμοποιείται σε κανένα συνηθισμένο στυλ γραφής.
  • Μην τοποθετείτε συνδέσμους στις κεφαλίδες. Αντί αυτού, συνδέστε τη λέξη ή φράση στην πρώτη εμφάνισή τους στο τμήμα του κειμένου.
  • Χωρίστε τα πολύ μακρόσυρτα τμήματα σε μερικά μικρότερα χρησιμοποιώντας υποκεφαλίδες.
  • Χρησιμοποιήστε το ---- για να δημιουργήσετε ένα οριζόντιο διαχωριστή πριν από κάθε κεφαλίδα 2ου επιπέδου (==), καθώς αυτό βοηθάει στην ομαλή ανάγνωση του άρθρου
Παράδειγμα:
 ==Κεφαλίδα 1==
 ===υποκεφαλίδα 1.1===
 ===υποκεφαλίδα 1.2===
 
 ----
 ==Κεφαλίδα 2==
 ===υποκεφαλίδα 2.2===
 ====υποκεφαλίδα 2.2.1====
 =====υποκεφαλίδα 2.2.1.1=====

 ----
 ==Κεφαλίδα 3==

Περιεχόμενο

Ορθογραφία της λέξης openSUSE

  • openSUSE είναι ο μόνος σωστός τρόπος για να γράψετε/συλλαβίσετε τη λέξη openSUSE. Τα "OpenSUSE", "openSuSE", OpenSuse" και άλλες ποικίλες παραλλαγές είναι όλες λανθασμένες. Καθώς το λογισμικό του MediaWiki αδυνατεί να χειριστεί τους τίτλους των σελίδων wiki με πεζά γράμματα, χρησιμοποιήστε το πρότυπο Template:Lowercase_title όταν γράφετε μια σελίδα wiki της οποίας ο τίτλος ξεκινάει με τη λέξη "openSUSE".
  • Μη χρησιμοποιείτε χαρακτήρες εμπορικών σημάτων (όπως το © ή το ®) καθώς αυτό εμποδίζει την ανάγνωση του άρθρου.
  • Σημειώστε ότι η χρήση των "SuSE Linux" και "SUSE Linux" αποδοκιμάζονται. Αν δεν αναφέρεστε ρητά σε κάποια παλιότερα διάθεση του openSUSE (10.1 και πιο πίσω) για ιστορικούς λόγους, στο SUSE Linux Enterprise Server (SLES) ή στο SUSE Linux Enterprise Desktop (SLED), χρησιμοποιήστε το "openSUSE".

Αναπαραγωγή

Μην αναπαράγετε προσπάθεια.

  • Ελέγξτε τη λίστα των ΟΔΗΓΩΝ του openSUSE. Υπάρχει μια ήδη μεγάλη συλλογή από άρθρα. Αν κάποιο από τα υπάρχοντα καλύπτει το θέμα για το οποίο θέλετε να γράψετε, τότε αφιερώστε χρόνο να το διαβάσετε και να δείτε αν μπορεί να βελτιωθεί.
  • Τα φόρα του openSUSE έχουν μια συλλογή από οδηγούς how to στη συζήτηση Προχωρημένοι οδηγοί/Συχνές ερωτήσεις.
  • Υπάρχει επίσης μια τεράστια συλλογή άρθρων οδηγών HOWTO Το Έργο Τεκμηρίωσης του Linux.

Ακρωνύμια και συντμήσεις

  • Όταν παρουσιάζετε νέα ακρωνύμια σε ένα άρθρο, χρησιμοποιήστε το πλήρες όνομα στην πρώτη εμφάνισή του ακολουθούμενο από την συντετμημένη μορφή εντός παρενθέσεως. Για παράδειγμα: Οι τίτλοι των τμημάτων αυτόματα σχηματίζουν τον πίνακα περιεχομένων (TOC).
  • Αποφύγετε πολύπλοκες συντμήσεις καθώς καθιστούν τα άρθρα δυσανάγνωστα.
  • Πάντα χρησιμοποιείτε πρότυπες και ευρέως κατανοητές συντμήσεις καθώς καινοτομία σε αυτόν τον τομέα μπορεί να οδηγήσει σε λάθος ερμηνεία.

Μεταβλητές

Μερικές φορές, η παράμετρος μιας εντολής εξαρτάται από το σύστημα του χρήστη, όπως οι συσκευές ή το όνομα χρήστη. Χρησιμοποιήστε τις ακόλουθες συμβάσεις:

  • <όνομα_χρήστη>, για παράδειγμα σε παραμέτρους διαδρομής /home/<όνομα_χρήστη>
  • sdX για συσκευές αποθήκευσης: το σημαντικό εδώ είναι ότι το γράμμα X είναι κεφαλαίο και η απλή αντιγραφή και επικόλληση θα παράγει ένα σφάλμα εκτέλεσης αντί κάποιας ζημιάς
  • Πείτε στον αναγνώστη τι να βάλει αντί του <όνομα_χρήστη> ή του sdX, δεν είναι όλοι εξοικειωμένοι με τις συμβάσεις που αναφέρονται εδώ.

Ασφάλεια άπειρου χρήστη

Προσοχή: Να είστε ιδιαίτερα προσεκτικοί όταν δίνετε εντολές που πρέπει να εκτελεστούν με δικαιώματα υπερχρήστη. Εντολές όπως dd, rm, fdisk, μπορούν να κάνουν σοβαρή ζημιά αν χρησιμοποιούνται χωρίς κατανόηση. Οι νέοι χρήστες συχνα δεν καταλαβαίνουν, αλλά απλά αντιγράφουν και επικολλούν την εντολή:

  • Χρησιμοποιήστε παραδείγματα κώδικα που αν χρησιμοποιηθούν ακριβώς όπως είναι σε κάποιο τερματικό θα οδηγήσουν σε κάποιο σφάλμα εκτέλεσης και όχι σε καταστροφή.
Λάθος: 
# dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sda
 Το /dev/sda είναι ο πρώτος σκληρός δίσκος που υπάρχει σε κάθε υπολογιστή.
Σωστό: 
# dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sdX
Το /dev/sdX δεν υπάρχει σε κανονικές εγκαταστάσεις, και το dd θα επιστρέψει σφάλμα σχετικά με το ανύπαρκτο /dev/sdX .

Εικόνες

Τοποθέτηση

Δείτε το Σήμανση εικόνας για προτάσεις σχετικά με την καλύτερη σήμανση προς χρήση. Για ιδέες και παραδείγματα του πώς να τοποθετήσετε εικόνες, δείτε τον οδηγό εικόνας.

Μορφότυπος

  • Σχέδια, εικονίδια και άλλες τέτοιες εικόνες (βασικά αυτές με μεγάλα, απλά, και συνεχόμενα τμήματα χρωμάτων) πρέπει να είναι σε μορφή PNG.
  • Οι φωτογραφίες πρέπει να είναι σε μορφή JPEG.
  • Τα κινούμενα σχέδια πρέπει να είναι σε κινούμενη μορφή GIF.
Σημειώστε ότι παλιές εκδόσεις άρθρων δεν δείχνουν τις αντίστοιχες παλιές εκδόσεις των εικόνων, αλλά τις πιο πρόσφατες, εκτός κι αν αλλάξουν τα ονόματα αρχείων των εικόνων.

Χρώματα

Αν χρησιμοποιήσετε χρώμα σε κάτι δείτε τη βοήθεια χρωμάτων για πίνακες χρωμάτων με τα πρότυπα χρώματα της διανομής και της ιστοσελίδας του openSUSE.

Σχόλια

  • Μην δημιουργείτε ακαταστασία στο άρθρο με σχόλια/ερωτήσεις στην επεξεργασία κειμένου. Αντί αυτού, χρησιμοποιήστε τη σελίδα συζήτησης του άρθρου.
  • Αν θέλετε να επικοινωνήσετε με άλλους συγγραφείς, κάντε τα σχόλια αόρατα στον κανονικό αναγνώστη του άρθρου με τη χρήση των ετικετών για σχόλια.
 <!-- Αυτό είναι ένα αόρατο σχόλιο.  -->

Επιθυμητές Σελίδες

Για να καταδείξετε την ανάγκη για κάποιο άρθρο που δεν υπάρχει ακόμα, δημιουργήστε ένα σύνδεσμο στο κείμενο κάποιου υπάρχοντος άρθρου. Αν υπάρχουν τουλάχιστον δύο σύνδεσμοι προς το ίδιο ανύπαρκτο άρθρο, θα εμφανιστεί στη λίστα με τις Επιθυμητές Σελίδες, η οποία αποτελεί πηγή έμπνευσης για πολλούς νέους αρθρογράφους του wiki. Αν και δε χρειάζονται όλα όσα αναφέρονται εκεί, η κοινή λογική και η εμπειρία σας θα σας πουν τι να διαλέξετε από τη λίστα.

Στοιχεία

Όταν γράφετε, βεβαιωθείτε ότι χρησιμοποιείτε τις ακόλουθες συμβάσεις.

Σήμανση του Wiki

Αν και είναι δυνατή η χρήση των ετικετών της HTML για να μορφοποιήσετε μια σελίδα, η χρήση της σήμανσης του MediaWiki θα κάνει ευκολότερη την ανάγνωση και την επεξεργασία του πηγαίου κειμένου. Μπορείτε επίσης να δείτε την καρτέλα αναφοράς του Wiki και τον πηγαίο κώδικα κάποιων άρθρων.

Πλήκτρο εντολής

F5 και Tab

  • Κώδικας: <code>Κουμπί για πάτημα</code>
  • Περιγραφή: Κουμπί στο πληκτρολόγιο για πάτημα.
  • Τοποθεσία: Οπουδήποτε

Διαδρομή εντολής

/usr/src/linux και /etc/SuSE-release

  • Κώδικας: <tt>/διαδρομή/σε/κατάλογο/ή/αρχείο</tt>
  • Περιγραφή: Περιγραφή διαδρομής καταλόγου και αρχείου.
  • Τοποθεσία: Οπουδήποτε

Είσοδος εντολής

$ user command
# root command
  • Κώδικας: {{Shell|$ user command}}, {{Shell|# root command}} ή <div class="shell">$ user/# root command</div>
  • Περιγραφή: Εντολή για να εισαχθεί.
  • Τοποθεσία: Οπουδήποτε

Έξοδος εντολής

κείμενο εξόδου
  • Κώδικας: (κενό)σύντομο κείμενο εξόδου ή <pre>εκτεταμένο κείμενο εξόδου</pre>
  • Περιγραφή: Περιγραφή του αποτελέσματος μιας εισηγμένης εντολής.
  • Τοποθεσία: Οπουδήποτε

Πρακτικά συναντήσεων

... Περιεχόμενο ...
  • Κώδικας: <div class="minutes"> ... Περιεχόμενο ... </div>
  • Περιγραφή: Εμφάνιση των πρακτικών συναντήσεων.
  • Τοποθεσία: Οπουδήποτε

Πίνακες

Κεφαλίδα 1 Κεφαλίδα 2 Κεφαλίδα 3 Κεφαλίδα 4 Κεφαλίδα 5 Κεφαλίδα 6
Επισημασμένο κείμενο Επισημασμένο κείμενο Επισημασμένο κείμενο Κείμενο Κείμενο Επισημασμένο κείμενο
Κείμενο Κείμενο Κείμενο Κείμενο Κείμενο Επισημασμένο κείμενο
Κείμενο Κείμενο Κείμενο Κείμενο Κείμενο Επισημασμένο κείμενο
  • Κώδικας: Δείτε τον κώδικα της σελίδας.
  • Περιγραφή: Εμφάνιση ενός πίνακα με προαιρετικά επισημασμένο κείμενο.
  • Τοποθεσία: Οπουδήποτε

Πρότυπα

Δείτε τις κατευθυντήριες γραμμές Προτύπων.

Δείτε επίσης

Εξωτερικοί σύνδεσμοι

Ανακτήθηκε από «https://el.opensuse.org/index.php?title=Βοήθεια:Style&oldid=5544»