SPB Git

Repository Public

AuditTexts.swift 15.6 KB 194 lines swift

1// ORIX Docs2// File: Packages/ORIXDocsKit/Sources/DocAudit/AuditTexts.swift3// Description: English and French (fr-CA) titles, explanations and suggestions of every audit check, in one table.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import Foundation89struct CheckText {10    var title: String11    var explanation: String12    var suggestion: String13}1415enum AuditTexts {16    static func isFrench(_ language: String) -> Bool { language.lowercased().hasPrefix("fr") }1718    static func text(_ check: AuditCheck, french: Bool) -> CheckText {19        let pair = table[check]!20        return french ? pair.fr : pair.en21    }2223    static let table: [AuditCheck: (en: CheckText, fr: CheckText)] = [24        .missingHeadings: (25            CheckText(title: "Long document without headings",26                      explanation: "The document is long and has no heading, so it has no outline, no table of contents and no navigation.",27                      suggestion: "Apply heading styles (Heading 1, Heading 2…) to the titles of the main parts."),28            CheckText(title: "Long document sans titres",29                      explanation: "Le document est long et ne contient aucun titre : il n'a ni plan, ni table des matières, ni navigation.",30                      suggestion: "Appliquez les styles de titre (Titre 1, Titre 2…) aux intitulés des grandes parties.")),31        .headingHierarchy: (32            CheckText(title: "Heading level skipped",33                      explanation: "The heading levels do not follow one another: a level is skipped or the document does not start at its top level.",34                      suggestion: "Change the heading to the expected level, or add the missing intermediate heading."),35            CheckText(title: "Niveau de titre sauté",36                      explanation: "Les niveaux de titre ne se suivent pas : un niveau est sauté ou le document ne commence pas à son niveau le plus élevé.",37                      suggestion: "Ramenez le titre au niveau attendu ou ajoutez le titre intermédiaire manquant.")),38        .brokenCrossReference: (39            CheckText(title: "Broken cross-reference",40                      explanation: "A cross-reference or internal link points to a heading, caption or bookmark that no longer exists; it prints as “??”.",41                      suggestion: "Point the reference to an existing target or delete it."),42            CheckText(title: "Renvoi brisé",43                      explanation: "Un renvoi ou un lien interne pointe vers un titre, une légende ou un signet qui n'existe plus ; il s'imprime « ?? ».",44                      suggestion: "Faites pointer le renvoi vers une cible existante ou supprimez-le.")),45        .missingFigureCaption: (46            CheckText(title: "Figure without caption",47                      explanation: "An image stands alone in its paragraph and no numbered figure caption is next to it, so it cannot be referenced or listed.",48                      suggestion: "Insert a caption (Insert ▸ Caption ▸ Figure) directly above or below the image."),49            CheckText(title: "Figure sans légende",50                      explanation: "Une image occupe seule son paragraphe et aucune légende de figure numérotée ne l'accompagne : elle ne peut être ni citée ni listée.",51                      suggestion: "Insérez une légende (Insertion ▸ Légende ▸ Figure) juste au-dessus ou au-dessous de l'image.")),52        .missingTableCaption: (53            CheckText(title: "Table without caption",54                      explanation: "No numbered table caption is next to this table, so it cannot be referenced or listed.",55                      suggestion: "Insert a caption (Insert ▸ Caption ▸ Table) directly above or below the table."),56            CheckText(title: "Tableau sans légende",57                      explanation: "Aucune légende de tableau numérotée n'accompagne ce tableau : il ne peut être ni cité ni listé.",58                      suggestion: "Insérez une légende (Insertion ▸ Légende ▸ Tableau) juste au-dessus ou au-dessous du tableau.")),59        .missingAltText: (60            CheckText(title: "Image without alternative text",61                      explanation: "The image has no alternative text; screen readers and the tagged PDF cannot describe it.",62                      suggestion: "Describe the image in one or two sentences in its alternative text."),63            CheckText(title: "Image sans texte de remplacement",64                      explanation: "L'image n'a pas de texte de remplacement ; les lecteurs d'écran et le PDF balisé ne peuvent pas la décrire.",65                      suggestion: "Décrivez l'image en une ou deux phrases dans son texte de remplacement.")),66        .inconsistentFormatting: (67            CheckText(title: "Formatting differs from the other paragraphs of the same style",68                      explanation: "Direct formatting makes this paragraph look different from the clear majority of the paragraphs that use the same style.",69                      suggestion: "Clear the direct formatting, or create a dedicated style if the difference is intended."),70            CheckText(title: "Mise en forme différente des autres paragraphes du même style",71                      explanation: "Une mise en forme directe distingue ce paragraphe de la nette majorité des paragraphes qui utilisent le même style.",72                      suggestion: "Effacez la mise en forme directe ou créez un style distinct si la différence est voulue.")),73        .unresolvedComment: (74            CheckText(title: "Unresolved comment",75                      explanation: "A comment is still open.",76                      suggestion: "Address the comment, then resolve or delete it before distributing the document."),77            CheckText(title: "Commentaire non résolu",78                      explanation: "Un commentaire est encore ouvert.",79                      suggestion: "Traitez le commentaire, puis résolvez-le ou supprimez-le avant de diffuser le document.")),80        .pendingTrackedChange: (81            CheckText(title: "Tracked changes pending",82                      explanation: "The document still contains tracked changes that were neither accepted nor rejected.",83                      suggestion: "Review the changes and accept or reject each of them."),84            CheckText(title: "Modifications suivies en attente",85                      explanation: "Le document contient encore des modifications suivies qui n'ont été ni acceptées ni refusées.",86                      suggestion: "Passez les modifications en revue et acceptez ou refusez chacune d'elles.")),87        .missingBibliographyEntry: (88            CheckText(title: "Citation without bibliography entry",89                      explanation: "The text cites a key that is not in the document's reference list; the citation cannot be formatted.",90                      suggestion: "Add the reference to the bibliography or correct the citation key."),91            CheckText(title: "Citation sans entrée bibliographique",92                      explanation: "Le texte cite une clé absente de la liste de références du document ; la citation ne peut pas être mise en forme.",93                      suggestion: "Ajoutez la référence à la bibliographie ou corrigez la clé de citation.")),94        .orphanedCitation: (95            CheckText(title: "References never cited",96                      explanation: "The reference list holds entries that the text never cites; they do not appear in the generated bibliography.",97                      suggestion: "Cite these works where they are used, or remove them from the reference list."),98            CheckText(title: "Références jamais citées",99                      explanation: "La liste de références contient des entrées que le texte ne cite jamais ; elles n'apparaissent pas dans la bibliographie générée.",100                      suggestion: "Citez ces ouvrages là où ils servent ou retirez-les de la liste de références.")),101        .incompleteReference: (102            CheckText(title: "Incomplete reference",103                      explanation: "A cited reference lacks fields that its type requires.",104                      suggestion: "Complete the missing fields in the reference manager."),105            CheckText(title: "Référence incomplète",106                      explanation: "Il manque à une référence citée des champs exigés par son type.",107                      suggestion: "Complétez les champs manquants dans le gestionnaire de références.")),108        .unusualPageBreak: (109            CheckText(title: "Unusual page break",110                      explanation: "A page break leaves a page empty or almost empty, or separates a heading from its text.",111                      suggestion: "Remove the superfluous break, or use “Keep with next” or “Page break before” on the paragraph instead."),112            CheckText(title: "Saut de page inhabituel",113                      explanation: "Un saut de page laisse une page vide ou presque vide, ou sépare un titre de son texte.",114                      suggestion: "Retirez le saut superflu ou utilisez plutôt « Lignes solidaires » ou « Saut de page avant » sur le paragraphe.")),115        .overflowingTable: (116            CheckText(title: "Table wider than the text area",117                      explanation: "The table is wider than the space between the margins; part of it is cut off or runs into the margin.",118                      suggestion: "Reduce the column widths, fit the table to the page width, or put it in a landscape section."),119            CheckText(title: "Tableau plus large que la zone de texte",120                      explanation: "Le tableau dépasse l'espace entre les marges ; une partie est coupée ou déborde dans la marge.",121                      suggestion: "Réduisez la largeur des colonnes, ajustez le tableau à la page ou placez-le dans une section en paysage.")),122        .missingPageNumbers: (123            CheckText(title: "Pages without page number",124                      explanation: "The document has several pages and some of them show no page number.",125                      suggestion: "Insert a page number field in the header or footer."),126            CheckText(title: "Pages sans numéro",127                      explanation: "Le document compte plusieurs pages et certaines n'affichent aucun numéro.",128                      suggestion: "Insérez un champ de numéro de page dans l'en-tête ou le pied de page.")),129        .emptyHeading: (130            CheckText(title: "Empty heading",131                      explanation: "A paragraph with a heading style contains no text; it leaves a gap and can produce an empty line in the table of contents.",132                      suggestion: "Type the heading text, delete the paragraph or give it the body style."),133            CheckText(title: "Titre vide",134                      explanation: "Un paragraphe en style de titre ne contient aucun texte ; il laisse un vide et peut créer une ligne vide dans la table des matières.",135                      suggestion: "Saisissez l'intitulé, supprimez le paragraphe ou donnez-lui le style du corps de texte.")),136        .duplicateHeading: (137            CheckText(title: "Duplicate heading",138                      explanation: "Two headings of the same level under the same parent have the same text; readers and cross-references cannot tell them apart.",139                      suggestion: "Rename one of the headings or merge the two sections."),140            CheckText(title: "Titre en double",141                      explanation: "Deux titres de même niveau sous le même parent portent le même intitulé ; ni le lecteur ni les renvois ne peuvent les distinguer.",142                      suggestion: "Renommez l'un des titres ou fusionnez les deux sections.")),143        .undefinedAcronym: (144            CheckText(title: "Acronym never spelled out",145                      explanation: "The acronym is used but its long form appears nowhere in the document.",146                      suggestion: "Spell it out at first use, followed by the acronym in parentheses."),147            CheckText(title: "Sigle jamais développé",148                      explanation: "Le sigle est employé, mais sa forme longue n'apparaît nulle part dans le document.",149                      suggestion: "Développez-le à la première occurrence, suivi du sigle entre parenthèses.")),150        .unreferencedFigure: (151            CheckText(title: "Figure never referenced",152                      explanation: "No cross-reference and no mention in the text points to this figure.",153                      suggestion: "Refer to the figure in the text (Insert ▸ Cross-reference) or remove it."),154            CheckText(title: "Figure jamais citée",155                      explanation: "Aucun renvoi ni aucune mention dans le texte ne désigne cette figure.",156                      suggestion: "Mentionnez la figure dans le texte (Insertion ▸ Renvoi) ou retirez-la.")),157        .unreferencedTable: (158            CheckText(title: "Table never referenced",159                      explanation: "No cross-reference and no mention in the text points to this table.",160                      suggestion: "Refer to the table in the text (Insert ▸ Cross-reference) or remove it."),161            CheckText(title: "Tableau jamais cité",162                      explanation: "Aucun renvoi ni aucune mention dans le texte ne désigne ce tableau.",163                      suggestion: "Mentionnez le tableau dans le texte (Insertion ▸ Renvoi) ou retirez-le.")),164        .repeatedWording: (165            CheckText(title: "Repeated wording",166                      explanation: "The same word or phrase comes back several times in a short stretch of text.",167                      suggestion: "Vary the wording or restructure the passage."),168            CheckText(title: "Répétition",169                      explanation: "Le même mot ou la même expression revient plusieurs fois dans un court passage.",170                      suggestion: "Variez la formulation ou restructurez le passage.")),171        .longSentence: (172            CheckText(title: "Very long sentence",173                      explanation: "The sentence is much longer than what reads comfortably.",174                      suggestion: "Split it into two or three sentences."),175            CheckText(title: "Phrase très longue",176                      explanation: "La phrase est nettement plus longue que ce qui se lit aisément.",177                      suggestion: "Scindez-la en deux ou trois phrases.")),178        .doubleSpaces: (179            CheckText(title: "Consecutive spaces",180                      explanation: "Two or more spaces follow one another between words.",181                      suggestion: "Replace them with a single space; use tabs, indents or alignment to position text."),182            CheckText(title: "Espaces consécutives",183                      explanation: "Deux espaces ou plus se suivent entre des mots.",184                      suggestion: "Remplacez-les par une seule espace ; utilisez les tabulations, les retraits ou l'alignement pour positionner le texte.")),185        .missingMetadata: (186            CheckText(title: "Document properties missing",187                      explanation: "Some document properties are empty; they are written to the PDF and used by search and accessibility tools.",188                      suggestion: "Fill them in under File ▸ Properties."),189            CheckText(title: "Propriétés du document manquantes",190                      explanation: "Certaines propriétés du document sont vides ; elles sont inscrites dans le PDF et servent à la recherche et à l'accessibilité.",191                      suggestion: "Renseignez-les dans Fichier ▸ Propriétés.")),192    ]193}194
Files main
Menu

Theme