feat: rendering of checkboxes in markdown (#381)

* added support for rendering checkboxes

* DCO Remediation Commit for Erik <[email protected]>

Signed-off-by: Erik <[email protected]>

* DCO Remediation Commit for Erik <[email protected]>

I, Erik <[email protected]>, hereby add my Signed-off-by to this commit: 7af4704

Signed-off-by: Erik <[email protected]>

* added code suggestions for better checkboxes

* updated test data

* fixed formatting

* DCO Remediation Commit for Erik <[email protected]>

I, Erik <[email protected]>, hereby add my Signed-off-by to this commit: fc7a57e
I, Erik <[email protected]>, hereby add my Signed-off-by to this commit: 7ea737e
I, Erik <[email protected]>, hereby add my Signed-off-by to this commit: 5c431b5

Signed-off-by: Erik <[email protected]>

---------

Signed-off-by: Erik <[email protected]>

Author: ErikApption

docling_core/transforms/serializer/markdown.py

@@ -40,6 +40,7 @@
     ContentLayer,
     DescriptionAnnotation,
     DocItem,
+    DocItemLabel,
     DoclingDocument,
     FloatingItem,
     Formatting,
@@ -140,6 +141,10 @@ def serialize(
             text = item.text
             processing_pending = True
 
+        if item.label == DocItemLabel.CHECKBOX_SELECTED:
+            text = f"- [x] {text}"
+        if item.label == DocItemLabel.CHECKBOX_UNSELECTED:
+            text = f"- [ ] {text}"
         if isinstance(item, (ListItem, TitleItem, SectionHeaderItem)):
             if not has_inline_repr:
                 # case where processing/formatting should be applied first (in inner scope)

test/data/doc/2408.09869v3_enriched.out.dt.json

@@ -0,0 +1,289 @@
+Security Classification / Classification de sécurité
+
+Contract Number / Numéro du contrat
+
+UNCLASSIFIED
+
+Gouvernement du Canada
+
+SECURITY REQUIREMENTS CHECK LIST (SRCL)
+
+LISTE DE VÉRIFICATION DES EXIGENCES RELATIVES À LA SÉCURITÉ (LVERS)
+
+4. Brief Description of Work - Brève description du travail
+
+5. a) Will the supplier require access to Controlled Goods? Le fournisseur aura-t-il accès à des marchandises contrôlées?
+
+- [x] Yes Oui
+
+- [ ] No Non
+
+5. b) Will the supplier require access to unclassified military technical data subject to the provisions of the Technical Data Control Regulations?
+
+- Le fournisseur aura-t-il accès à des données techniques militaires non classifiées qui sont assujetties aux dispositions du Règlement sur le contrôle des données techniques?
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+6. Indicate the type of access required - Indiquer le type d'accès requis
+
+1. Originating Government Department or Organization Ministère ou organisme gouvernemental d'origine
+
+## PART A - CONTRACT INFORMATION / PARTIE A - INFORMATION CONTRACTUELLE
+
+2. Branch or Directorate / Direction générale ou Direction
+
+3. a) Subcontract Number / Numéro du contrat de sous-traitance
+
+3. b) Name and Address of Subcontractor / Nom et adresse du sous-traitant
+
+6. c) Is this a commercial courier or delivery requirement with no overnight storage? S'agit-il d'un contrat de messagerie ou de livraison commerciales sans entreposage de nuit?
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+7. a) Indicate the type of information that the supplier will be required to access / Indiquer le type d'information auquel le fournisseur devra avoir accès
+
+Canada
+
+7. b) Release restrictions / Restrictions relatives à la diffusion
+
+Foreign / Étranger
+
+- [ ] NATO / OTAN
+
+No release restrictions
+
+- [ ] Aucune restriction relative à la diffusion
+
+Not releasable À ne pas diffuser
+
+- [ ] Restricted to: / Limité à :
+
+Specify country(ies): / Préciser le(s) pays :
+
+All NATO countries Tous les pays de l'OTAN
+
+Specify country(ies): / Préciser le(s) pays :
+
+- [ ] No release restrictions Aucune restriction relative à la diffusion
+
+Restricted to: / Limité à :
+
+Specify country(ies): / Préciser le(s) pays :
+
+Restricted to: / Limité à :
+
+7. c) Level of information / Niveau d'information
+
+PROTECTED A PROTÉGÉ A
+
+PROTECTED B PROTÉGÉ B
+
+- [ ] PROTECTED C PROTÉGÉ C
+
+CONFIDENTIAL
+
+CONFIDENTIEL
+
+SECRET SECRET
+
+- [ ] TOP SECRET TRÈS SECRET
+
+- [ ] TOP SECRET (SIGINT) TRÈS SECRET (SIGINT)
+
+NATO UNCLASSIFIED
+
+- [ ] NATO NON CLASSIFIÉ
+
+- [ ] NATO RESTRICTED NATO DIFFUSION RESTREINTE
+
+NATO CONFIDENTIAL
+
+- [ ] NATO CONFIDENTIEL
+
+PROTECTED A
+
+- [ ] PROTÉGÉ A
+
+- [ ] PROTECTED B
+
+PROTÉGÉ B
+
+PROTECTED C
+
+- [ ] PROTÉGÉ C
+
+CONFIDENTIAL CONFIDENTIEL
+
+SECRET SECRET
+
+TOP SECRET
+
+- [ ] TRÈS SECRET
+
+TOP SECRET (SIGINT)
+
+- [ ] TRÈS SECRET (SIGINT)
+
+NATO SECRET
+
+- [ ] NATO SECRET
+
+COSMIC TOP SECRET
+
+- [ ] COSMIC TRÈS SECRET
+
+6. a) Will the supplier and its employees require access to PROTECTED and/or CLASSIFIED information or assets? Le fournisseur ainsi que les employés auront-ils accès à des renseignements ou à des biens PROTÉGÉS et/ou CLASSIFIÉS? (Specify the level of access using the chart in Question 7. c)
+
+- (Préciser le niveau d'accès en utilisant le tableau qui se trouve à la question 7. c)
+
+- [x] Yes Oui
+
+- [ ] No Non
+
+6. b) Will the supplier and its employees (e.g. cleaners, maintenance personnel) require access to restricted access areas? No access to PROTECTED and/or CLASSIFIED information or assets is permitted. Le fournisseur et ses employés (p.ex. nettoyeurs, personnel d'entretien) auront-ils accès à des zones d'accès restreintes? L'accès à des renseignements ou à des biens PROTÉGÉS et/ou CLASSIFIÉS n'est pas autorisé.
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+- [ ] not applicable
+
+The Contractor will perform tasks applicable to the Land Intelligence, Surveillance, Reconnaissance Modernization (LISRM) Project.
+
+Security Classification / Classification de sécurité
+
+TBS/SCT 350-103 (2004/12)
+
+UNCLASSIFIED
+
+<!-- page break -->
+
+Security Classification / Classification de sécurité
+
+Contract Number / Numéro du contrat
+
+## PART A (continued) / PARTIE A (suite)
+
+8. Will the supplier require access to PROTECTED and/or CLASSIFIED COMSEC information or assets? Le fournisseur aura-t-il accès à des renseignements ou à des biens COMSEC désignés PROTÉGÉS et/ou CLASSIFIÉS? If Yes, indicate the level of sensitivity:
+
+Dans l'affirmative, indiquer le niveau de sensibilité :
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+11. d) Will the supplier be required to use its IT systems to electronically process, produce or store PROTECTED and/or CLASSIFIED information or data?
+
+- Le fournisseur sera-t-il tenu d'utiliser ses propres systèmes informatiques pour traiter, produire ou stocker électroniquement des renseignements ou des données PROTÉGÉS et/ou CLASSIFIÉS?
+
+11. e) Will there be an electronic link between the supplier's IT systems and the government department or agency? Disposera-t-on d'un lien électronique entre le système informatique du fournisseur et celui du ministère ou de l'agence gouvernementale?
+
+## INFORMATION TECHNOLOGY (IT) MEDIA / SUPPORT RELATIF À LA TECHNOLOGIE DE L'INFORMATION (TI)
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+11. c) Will the production (manufacture, and/or repair and/or modification) of PROTECTED and/or CLASSIFIED material or equipment occur at the supplier's site or premises?
+
+- Les installations du fournisseur serviront-elles à la production (fabrication et/ou réparation et/ou modification) de matérial
+
+PROTÉGÉ et/ou CLASSIFIÉ?
+
+## PRODUCTION
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+## PART C - SAFEGUARDS (SUPPLIER) / PARTIE C - MESURES DE PROTECTION (FOURNISSEUR)
+
+11. a) Will the supplier be required to receive and store PROTECTED and/or CLASSIFIED information or assets on its site or premises?
+
+- Le fournisseur sera-t-il tenu de recevoir et d'entreposer sur place des renseignements ou des biens PROTÉGÉS et/ou CLASSIFIÉS?
+
+11. b) Will the supplier be required to safeguard COMSEC information or assets?
+
+Le fournisseur sera-t-il tenu de protéger des renseignements ou des biens COMSEC?
+
+INFORMATION / ASSETS / RENSEIGNEMENTS / BIENS
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+10. b) May unscreened personnel be used for portions of the work?
+
+Du personnel sans autorisation sécuritaire peut-il se voir confier des parties du travail?
+
+If Yes, will unscreened personnel be escorted:
+
+Dans l'affirmative, le personnel en question sera-t-il escorté?
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+## PART B - PERSONNEL (SUPPLIER) / PARTIE B - PERSONNEL (FOURNISSEUR)
+
+10. a) Personnel security screening level required / Niveau de contrôle de la sécurité du personnel requis
+
+- [x] RELIABILITY STATUS COTE DE FIABILITÉ
+
+- [ ] CONFIDENTIAL CONFIDENTIEL
+
+- [ ] SECRET SECRET
+
+- [ ] TOP SECRET TRÈS SECRET
+
+- [ ] NATO CONFIDENTIAL NATO CONFIDENTIEL
+
+- [ ] NATO SECRET NATO SECRET
+
+- [ ] COSMIC TOP SECRET COSMIC TRÈS SECRET
+
+- [ ] SITE ACCESS ACCÈS AUX EMPLACEMENTS
+
+- [ ] TOP SECRET - SIGINT TRÈS SECRET - SIGINT
+
+- 9.
+
+- Will the supplier require access to extremely sensitive INFOSEC information or assets: Le fournisseur aura-t-il accès à des renseignements ou à des biens INFOSEC de nature extrêmement délicate?
+
+Short Title(s) of material / Titre(s) abrégé(s) du matériel :
+
+Document Number / Numéro du document :
+
+- [ ] Yes Oui
+
+- [x] No Non
+
+Special comments:
+
+Commentaires spéciaux :
+
+NOTE: If multiple levels of screening are identified, a Security Classification Guide must be provided.
+
+REMARQUE : Si plusieurs niveaux de contrôle de sécurité sont requis, un guide de classification de la sécurité doit être fourni.
+
+- [ ] Not applicable
+
+Security Classification / Classification de sécurité
+
+UNCLASSIFIED