Projects Manual

h1. Naming

{{>toc}}

Επειδή υπάρχει μεγάλη διαφοροποίηση στις ονομασίες των end-user αρχείων για τα προϊόντα μας (manuals, guides, flyers, PDF, links, firmware, software κλπ) περιγράφω παρακάτω πως πρέπει να είναι η μορφή του filename:

h2. Γενικοί κανόνες

1.	Η γενική ονομασία πρέπει να είναι της μορφής *ΟΝΟΜΑΣΙΑ_Είδος_ΓΛΩΣΣΑ_VERSION.επέκταση*

2.	Δεν επιτρέπονται οι κενοί χαρακτήρες (space).

3.	Δεν επιτρέπονται ελληνικά γράμματα. Οι μεταφράσεις στα μέρη του filename γίνονται από το website βάσει εσωτερικού πίνακα (βλ. § Website.6)

4.	Δεν επιτρέπονται σύμβολα πλην των: underscore(_) ανάμεσα στα στοιχεία, παύλα(-) στην ονομασία, τελεία(.) στη version και πριν την επέκταση.

5.	Τα επιμέρους στοιχεία χωρίζονται πάντα από ένα underscore (_) και η επέκταση από μια τελεία.

6.	Η *ΟΝΟΜΑΣΙΑ* μπορεί να αναφέρεται σε:

**      *ΜΟΝΤΕΛΟ*

#	Μπορεί να έχει παύλες (-).

#	Επιτρέπονται ΜΟΝΟ κεφαλαία.

#	+ΑΠΑΓΟΡΕΥΟΝΤΑΙ+ τα κενά (space), τα slash (/) και κάθε άλλος χαρακτήρας που ΔΕΝ είναι λατινικός αλφαριθμητικός.

**	*ΚΑΤΗΓΟΡΙΑ* πχ. CompactLine2 ή MLF-MLC. 

#	Κι εδώ μπορεί να έχει παύλες (-).

#	Επιτρέπονται μεγάλα και μικρά γράμματα.

#	Πάντα το πρώτο γράμμα λέξης είναι κεφαλαίο π.χ. CompactLine2 και όχι compactline2 

#	ΑΠΑΓΟΡΕΥΟΝΤΑΙ τα κενά (space), τα slash (/) και κάθε άλλος χαρακτήρας που ΔΕΝ είναι λατινικός αλφαριθμητικός.

7.	Το *ΕΙΔΟΣ* είναι ολογράφως και μπορεί να είναι μόνο ένα από τα εξής: Setup, Manual, Guide, Flyer, CE, RoHS, App, Software

***	Το *Setup* μπορεί να περιγράφει μόνο την εγκατάσταση hardware. Κανονικά πρέπει να είναι στο πρώτο ή δεύτερο κεφάλαιο του Manual.

***	Το *Manual* είναι αναλυτικό εγχειρίδιο / user manual / user guide. Κανονικά πρέπει να περιλαμβάνει την εγκατάσταση του hardware (Setup) και τις γρήγορες ρυθμίσεις (Guide) στα πρώτα κεφάλαια.

***	Το *Guide* είναι το "quick guide" / "quick manual" / "quick setup" και κανονικά πρέπει να ενσωματώνεται σαν πρώτο ή δεύτερο κεφάλαιο στο Manual.

***	Το *Flyer* είναι προφανές.

***	Τα *CE* και RoHS είναι για certification. ΔΕΝ πρέπει να περιλαμβάνεται η λέξη "certification" στο filename (βλ. § Εξαιρέσεις.2 & § Website.5)

***	Το *App* είναι για link σε αντίστοιχα play store / app store. Συνήθως με γλώσσα ALL (βλ. § Εξαιρέσεις.3)

***	Το *Software* είναι μόνο για την περίπτωση που το συγκεκριμένο μοντέλο έχει δικό του αποκλειστικό software (βλ. § Εξαιρέσεις.1)

8.	H *ΓΛΩΣΣΑ* μπορεί να είναι ΜΟΝΟ ΔΥΟ γράμματα (προς το παρόν EN, GR) ή "ALL" (βλ. § Εξαιρέσεις.3)

9.	Η *VERSION* είναι optional και human readable: πχ "v1.2", όχι 1v2. 

***	πάντα αρχίζει με "v" μικρό λατινικό.

***	πάντα ακολουθούν ένα έως 4 αριθμητικά ψηφία (major version) - μπορεί να χρησιμοποιηθεί έτος.

***	πάντα ακολουθεί μια τελεία.

***	πάντα ακολουθεί ένα ή δύο κεφαλαία ΗΕΧ ψηφία (minor version) ακόμα κι αν είναι μηδέν (0).

10.	Η *επέκταση* είναι πάντα 3 λατινικά μικρά γράμματα και μπορεί να είναι μόνο ένα από τα παρακάτω:

***	pdf

***	lnk

***	zip

***	bin

11.	Αν χρειάζεται να μπει εικόνα jpg / png στα downloads, αυτή θα μπει υποχρεωτικά μέσα σε PDF.

12.	Δε συμπιέζουμε ποτέ τα αρχεία PDF.

13.	Μπορούμε να συμπιέσουμε τα αρχεία .bin σε .zip

14.	Δεν προσθέτουμε πρόθεμα *Lemco* ή *LEMCO* (βλ. § Website.4)

h2. Εξαιρέσεις

#	Για το software που να αναφέρεται σε περισσότερες της μίας συσκευές ή κατηγορίες, το filename μπορεί να ακολουθήσει το εξής format: ονομασίαΤουSoftware_Software_ALL_v1.2.zip

#	Τα certifications παρόλο που είναι μόνο στα αγγλικά, περιέχουν στο filename τη γλώσσα (_EN_) και το έτος έκδοσης ως version πχ _v2022.0

#	Για τα αρχεία που περιέχουν ΟΛΕΣ τις γλώσσες που υποστηρίζουμε (προς το παρόν EN και GR), αντί δύο γραμμάτων γλώσσας στο filename μπαίνει ALL

h2. Website

Το website φροντίζει να κάνει τα εξής:

#	Παρουσιάζει λίστα με downloads, είτε μόνο για συγκεκριμένο μοντέλο είτε για την κατηγορία ΚΑΙ ΕΠΙΠΛΕΟΝ για το μοντέλο πχ. CE certificate για CompactLine2 και επιπλέον Manual για SCL-834CT

#	Στη λίστα δείχνει downloads ΧΩΡΙΣ μοντέλο/κατηγορία/γλώσσα/extension. Όσα χρειάζονται, φαίνονται με σημαιούλα και εικονίδιο τύπου αντίστοιχα.

#	Για τα links ανοίγει άλλο tab, για όλα τα άλλα προκαλεί download.

#	Όταν ο χρήστης κάνει download, στο filename, στη μεριά του χρήστη μόνο, προστίθεται και το πρόθεμα *Lemco_*

#	Τα **_CE_ & _RoHS_** γίνονται στη μεριά του χρήστη μόνο *_CE-certificate_* & *_RoHS-certificate_* αντίστοιχα.

#	Για τα *είδη (Setup / Manual* κλπ) αρχείων και τις μεταφράσιμες κατηγορίες, η μετάφραση γίνεται από το website, στη μεριά του χρήστη μόνο.

h2. Παραδείγματα

| *Παλιά ονομασία*  |HCL-824CT_FENG_1v2.PDF|Certificate MLF-MLC series CE.pdf|Lemco_ModConfig_software_1v1.zip|

| *Νέα ονομασία*  |HCL-824CT_Flyer_EN_v1.2.pdf|MLF-MLC_CE_EN_v2022.0.pdf  |ModConfig_Software_ALL_v1.1.zip  |

|  |  |  |  |

|/4. *Προβλήματα παλιάς ονομασίας*  |Τρία γράμματα γλώσσας   |Κενά (space)                            |Η λέξη "Lemco"  |

                                  |Αντικανονική version    |Οι λέξεις certificate & series          |Αντικανονική version |

                                  |Κεφαλαία στο extension  |Έλλειψη γλώσσας	                    |Έλλειψη γλώσσας|

                                  ||Έλλειψη έτους ή version |Η λέξη software δεν ξεκινά με κεφαλαίο|

Όπου βρίσκονται filename που παρεκκλίνουν από τις παραπάνω οδηγίες, θα μετονομάζονται κατάλληλα. Παρακαλώ να ειδοποιείτε τον project manager αν εντοπίσετε αρχεία με filenames που παρεκκλίνουν.