[PATCH eac] [doc] Enhance documentation about supported elements

Sylvain Thenault sylvain.thenault at logilab.fr
Fri Mar 31 17:59:46 CEST 2017


# HG changeset patch
# User Sylvain Thénault <sylvain.thenault at logilab.fr>
# Date 1490955326 -7200
#      Fri Mar 31 12:15:26 2017 +0200
# Node ID a1817189cc29d197072e79c6e4fddc796996fdc0
# Parent  5ce05f9132b21bda8c902675b1d419dd1d9e428e
[doc] Enhance documentation about supported elements

fix ReST syntax for table and better rendering for support markers

diff --git a/doc/supported.rst b/doc/supported.rst
--- a/doc/supported.rst
+++ b/doc/supported.rst
@@ -1,139 +1,141 @@
-Import EAC-CPF
-==============
+Compatibilité EAC-CPF
+=====================
 
-Le tableau ci-dessous référence les balises XML du format `EAC-CPF`_ prises en
-compte ou non par le SAEM au moment de l'import. Les points ``.`` indiquent
-que la balise est prise en compte (pour certaines partiellement). Les ``X``
+Le tableau ci-dessous référence les `balises XML du format EAC-CPF`_ prises en
+compte ou non au moment de l'import. Les points ``.`` indiquent
+que la balise est prise en compte (pour certaines partiellement). Les ``x``
 indiquent que la balise n'est pas prise en compte, les ``-`` qu'elle ne l'est
 que partiellement.
 
-.. _`EAC-CPF`: http://eac.staatsbibliothek-berlin.de/fileadmin/user_upload/schema/cpfTagLibrary.html
-
-::
+.. _`balises XML du format EAC-CPF`: http://eac.staatsbibliothek-berlin.de/fileadmin/user_upload/schema/cpfTagLibrary.html
 
-    |     |     EAC-CPF Elements     |
-    |=====|==========================|
-    |  X  |       abbreviation       |
-    |  X  |         abstract         |
-    |  .  |         address          |
-    |  .  |       addressLine        |
-    |  X  |        agencyCode        |
-    |  X  |        agencyName        |
-    |  .  |          agent           |
-    |  .  |        agentType         |
-    |  X  |     alternativeForm      |
-    |  X  |      alternativeSet      |
-    |  .  |      authorizedForm      |
-    |  .  |         biogHist         |
-    |  X  |        chronItem         |
-    |  X  |        chronList         |
-    |  .  |         citation         |
-    |  X  |      componentEntry      |
-    |  .  |         control          |
-    |  X  |  conventionDeclaration   |
-    |  .  |      cpfDescription      |
-    |  .  |       cpfRelation        |
-    |  .  |           date           |
-    |  .  |        dateRange         |
-    |  X  |         dateSet          |
-    |  .  |       description        |
-    |  .  |     descriptiveNote      |
-    |  .  |         eac-cpf          |
-    |  .  |         entityId         |
-    |  .  |        entityType        |
-    |  X  |          event           |
-    |  .  |      eventDateTime       |
-    |  .  |     eventDescription     |
-    |  .  |        eventType         |
-    |  .  |        existDates        |
-    |  .  |         fromDate         |
-    |  .  |         function         |
-    |  X  |     functionRelation     |
-    |  .  |        functions         |
-    |  .  |      generalContext      |
-    |  .  |         identity         |
-    |  X  |           item           |
-    |  X  |         language         |
-    |  X  |   languageDeclaration    |
-    |  X  |      languagesUsed       |
-    |  X  |       languageUsed       |
-    |  .  |       legalStatus        |
-    |  .  |      legalStatuses       |
-    |  X  |          level           |
-    |  X  |           list           |
-    |  X  |       localControl       |
-    |  X  |     localDescription     |
-    |  X  |    localDescriptions     |
-    |  X  |   localTypeDeclaration   |
-    |  X  |    maintenanceAgency     |
-    |  .  |     maintenanceEvent     |
-    |  .  |    maintenanceHistory    |
-    |  X  |    maintenanceStatus     |
-    |  .  |         mandate          |
-    |  .  |         mandates         |
-    |  X  |    multipleIdentities    |
-    |  .  |        nameEntry         |
-    |  X  |    nameEntryParallel     |
-    |  X  |      objectBinWrap       |
-    |  .  |      objectXMLWrap       |
-    |  .  |        occupation        |
-    |  .  |       occupations        |
-    |  X  |     otherAgencyCode      |
-    |  X  |      otherRecordId       |
-    |  X  |         outline          |
-    |  .  |            p             |
-    |  X  |           part           |
-    |  .  |          place           |
-    |  .  |        placeEntry        |
-    |  .  |        placeRole         |
-    |  .  |          places          |
-    |  X  |      preferredForm       |
-    |  X  |    publicationStatus     |
-    |  .  |         recordId         |
-    |  .  |      relationEntry       |
-    |  .  |        relations         |
-    |  .  |     resourceRelation     |
-    |  X  |          script          |
-    |  X  |       setComponent       |
-    |  .  |          source          |
-    |  .  |       sourceEntry        |
-    |  .  |         sources          |
-    |  .  |           span           |
-    |  .  |   structureOrGenealogy   |
-    |  .  |           term           |
-    |  .  |          toDate          |
-    |  X  |         useDates         |
+===== ==========================
+Sup.       Éléments EAC-CPF     
+===== ==========================
+  x          abbreviation       
+  x            abstract         
+  .            address          
+  .          addressLine        
+  x           agencyCode        
+  x           agencyName        
+  .             agent           
+  .           agentType         
+  x        alternativeForm      
+  x         alternativeSet      
+  .         authorizedForm      
+  .            biogHist         
+  x           chronItem         
+  x           chronList         
+  .            citation         
+  x         componentEntry      
+  .            control          
+  x     conventionDeclaration   
+  .         cpfDescription      
+  .          cpfRelation        
+  .              date           
+  .           dateRange         
+  x            dateSet          
+  .          description        
+  .        descriptiveNote      
+  .            eac-cpf          
+  .            entityId         
+  .           entityType        
+  x             event           
+  .         eventDateTime       
+  .        eventDescription     
+  .           eventType         
+  .           existDates        
+  .            fromDate         
+  .            function         
+  x        functionRelation     
+  .           functions         
+  .         generalContext      
+  .            identity         
+  x              item           
+  x            language         
+  x      languageDeclaration    
+  x         languagesUsed       
+  x          languageUsed       
+  .          legalStatus        
+  .         legalStatuses       
+  x             level           
+  x              list           
+  x          localControl       
+  x        localDescription     
+  x       localDescriptions     
+  x      localTypeDeclaration   
+  x       maintenanceAgency     
+  .        maintenanceEvent     
+  .       maintenanceHistory    
+  x       maintenanceStatus     
+  .            mandate          
+  .            mandates         
+  x       multipleIdentities    
+  .           nameEntry         
+  x       nameEntryParallel     
+  x         objectBinWrap       
+  .         objectXMLWrap       
+  .           occupation        
+  .          occupations        
+  x        otherAgencyCode      
+  x         otherRecordId       
+  x            outline          
+  .               p             
+  x              part           
+  .             place           
+  .           placeEntry        
+  .           placeRole         
+  .             places          
+  x         preferredForm       
+  x       publicationStatus     
+  .            recordId         
+  .         relationEntry       
+  .           relations         
+  .        resourceRelation     
+  x             script          
+  x          setComponent       
+  .             source          
+  .          sourceEntry        
+  .            sources          
+  .              span           
+  .      structureOrGenealogy   
+  .              term           
+  .             toDate          
+  x            useDates         
+===== ==========================
 
 
-    |     |     EAC-CPF Attributes   |
-    |=====|==========================|
-    |  X  |  @accuracy               |
-    |  X  |  @altitude               |
-    |  X  |  @countryCode            |
-    |  .  |  @cpfRelationType        |
-    |  X  |  @functionRelationType   |
-    |  X  |  @identityType           |
-    |  X  |  @languageCode           |
-    |  X  |  @lastDateTimeVerified   |
-    |  X  |  @latitude               |
-    |  -  |  @localType              |
-    |  X  |  @longitude              |
-    |  X  |  @notAfter               |
-    |  X  |  @notBefore              |
-    |  .  |  @resourceRelationType   |
-    |  X  |  @scriptCode             |
-    |  .  |  @standardDate           |
-    |  .  |  @standardDateTime       |
-    |  X  |  @style                  |
-    |  X  |  @transliteration        |
-    |  .  |  @vocabularySource       |
-    |  X  |  @xlink:actuate          |
-    |  X  |  @xlink:arcrole          |
-    |  -  |  @xlink:href             |
-    |  -  |  @xlink:role             |
-    |  X  |  @xlink:show             |
-    |  X  |  @xlink:title            |
-    |  X  |  @xlink:type             |
-    |  X  |  @xml:base               |
-    |  X  |  @xml:id                 |
-    |  X  |  @xml:lang               |
+===== ==========================
+Sup.       Attributs EAC-CPF    
+===== ==========================
+  x     @accuracy               
+  x     @altitude               
+  x     @countryCode            
+  .     @cpfRelationType        
+  x     @functionRelationType   
+  x     @identityType           
+  x     @languageCode           
+  x     @lastDateTimeVerified   
+  x     @latitude               
+  \-    @localType              
+  x     @longitude              
+  x     @notAfter               
+  x     @notBefore              
+  .     @resourceRelationType   
+  x     @scriptCode             
+  .     @standardDate           
+  .     @standardDateTime       
+  x     @style                  
+  x     @transliteration        
+  .     @vocabularySource       
+  x     @xlink:actuate          
+  x     @xlink:arcrole          
+  \-    @xlink:href             
+  \-    @xlink:role             
+  x     @xlink:show             
+  x     @xlink:title            
+  x     @xlink:type             
+  x     @xml:base               
+  x     @xml:id                 
+  x     @xml:lang               
+===== ==========================


More information about the saem-devel mailing list