Harmonize ASCII usage across all packages

Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt

@@ -3475,7 +3475,7 @@ This package provides an <I>inserter</I> (the `<<` operator) and an
 `Arrangement_2<Traits,Dcel>` class that inserts and an arrangement
 object into an output stream and extracts an arrangement object from an
 input stream respectively. The arrangement is written using a simple
-predefined ASCII format that encodes the arrangement topology, as well
+predefined \ascii format that encodes the arrangement topology, as well
 as all geometric entities associated with vertices and edges.
 
 The ability to use the input/output operators, requires that the
@@ -3560,7 +3560,7 @@ with the basic arrangement structure.
 
 The arrangement package supplies an inserter and an extractor for the
 `Arrangement_with_history_2<Traits,Dcel>` class. The arrangement is
-represented using a simple predefined ASCII format. An object of the
+represented using a simple predefined \ascii format. An object of the
 `Arrangement_with_history_2<Traits,Dcel>` type can be saved and
 restored, as long as the `Curve_2` type defined by the traits
 class - as well as the `Point_2` type and the `X_monotone_curve_2`

Arrangement_on_surface_2/include/CGAL/IO/Arr_text_formatter.h

@@ -27,7 +27,7 @@
 namespace CGAL {
 
 /*! \class
- * A class defining a textual (ASCII) input/output format for arrangements
+ * A class defining a textual (\ascii) input/output format for arrangements
  * and supports reading and writing an arrangement from or to input/output
  * streams.
  */
@@ -489,7 +489,7 @@ class Arr_text_formatter
 };
 
 /*! \class
- * A class defining a textual (ASCII) input/output format for arrangements
+ * A class defining a textual (\ascii) input/output format for arrangements
  * that store auxiliary dat with their face records, as they are templated
  * by a face-extended DCEL class.
  */
@@ -546,7 +546,7 @@ class Arr_face_extended_text_formatter :
 };
 
 /*! \class
- * A class defining a textual (ASCII) input/output format for arrangements
+ * A class defining a textual (\ascii) input/output format for arrangements
  * that store auxiliary dat with all their DCEL records, as they are templated
  * by a extended DCEL class.
  */

Arrangement_on_surface_2/include/CGAL/IO/Arr_with_history_text_formatter.h

@@ -26,7 +26,7 @@
 namespace CGAL {
 
 /*! \class
- * A class defining a textual (ASCII) input/output format for arrangements
+ * A class defining a textual (\ascii) input/output format for arrangements
  * with history and supports reading and writing an arrangement from or to
  * input/output streams.
  */

BGL/include/CGAL/boost/graph/IO/PLY.h

@@ -175,7 +175,7 @@ bool read_PLY(std::istream& is, Graph& g,
 
   \cgalNamedParamsBegin
     \cgalParamNBegin{use_binary_mode}
-      \cgalParamDescription{indicates whether data should be read in binary (`true`) or in ASCII (`false`)}
+      \cgalParamDescription{indicates whether data should be read in binary (`true`) or in \ascii (`false`)}
       \cgalParamType{Boolean}
       \cgalParamDefault{`true`}
     \cgalParamNEnd
@@ -311,7 +311,7 @@ bool read_PLY(const std::string& fname, Graph& g,
       \cgalParamDescription{a parameter used to set the precision (i.e. how many digits are generated) of the output stream}
       \cgalParamType{int}
       \cgalParamDefault{the precision of the stream `os`}
-      \cgalParamExtra{This parameter is only meaningful while using ASCII encoding.}
+      \cgalParamExtra{This parameter is only meaningful while using \ascii encoding.}
     \cgalParamNEnd
  \cgalNamedParamsEnd
 
@@ -482,7 +482,7 @@ bool write_PLY(std::ostream& os, const Graph& g,
 
  \cgalNamedParamsBegin
     \cgalParamNBegin{use_binary_mode}
-      \cgalParamDescription{indicates whether data should be written in binary (`true`) or in ASCII (`false`)}
+      \cgalParamDescription{indicates whether data should be written in binary (`true`) or in \ascii (`false`)}
       \cgalParamType{Boolean}
       \cgalParamDefault{`true`}
     \cgalParamNEnd
@@ -521,7 +521,7 @@ bool write_PLY(std::ostream& os, const Graph& g,
       \cgalParamDescription{a parameter used to set the precision (i.e. how many digits are generated) of the output stream}
       \cgalParamType{int}
       \cgalParamDefault{`6`}
-      \cgalParamExtra{This parameter is only meaningful while using ASCII encoding.}
+      \cgalParamExtra{This parameter is only meaningful while using \ascii encoding.}
     \cgalParamNEnd
  \cgalNamedParamsEnd
 

BGL/include/CGAL/boost/graph/IO/STL.h

@@ -135,7 +135,7 @@ bool read_STL(std::istream& is,
 
   \cgalNamedParamsBegin
     \cgalParamNBegin{use_binary_mode}
-      \cgalParamDescription{indicates whether data should be read in binary (`true`) or in ASCII (`false`)}
+      \cgalParamDescription{indicates whether data should be read in binary (`true`) or in \ascii (`false`)}
       \cgalParamType{Boolean}
       \cgalParamDefault{`true`}
     \cgalParamNEnd
@@ -231,7 +231,7 @@ bool read_STL(const std::string& fname, Graph& g) { return read_STL(fname, g, pa
       \cgalParamDescription{a parameter used to set the precision (i.e. how many digits are generated) of the output stream}
        \cgalParamType{int}
        \cgalParamDefault{the precision of the stream `os`}
-       \cgalParamExtra{This parameter is only meaningful while using ASCII encoding.}
+       \cgalParamExtra{This parameter is only meaningful while using \ascii encoding.}
     \cgalParamNEnd
   \cgalNamedParamsEnd
 
@@ -328,7 +328,7 @@ bool write_STL(std::ostream& os,
 
   \cgalNamedParamsBegin
     \cgalParamNBegin{use_binary_mode}
-      \cgalParamDescription{indicates whether data should be written in binary (`true`) or in ASCII (`false`)}
+      \cgalParamDescription{indicates whether data should be written in binary (`true`) or in \ascii (`false`)}
       \cgalParamType{Boolean}
       \cgalParamDefault{`true`}
     \cgalParamNEnd
@@ -346,7 +346,7 @@ bool write_STL(std::ostream& os,
       \cgalParamDescription{a parameter used to set the precision (i.e. how many digits are generated) of the output stream}
        \cgalParamType{int}
        \cgalParamDefault{`6`}
-       \cgalParamExtra{This parameter is only meaningful while using ASCII encoding.}
+       \cgalParamExtra{This parameter is only meaningful while using \ascii encoding.}
     \cgalParamNEnd
   \cgalNamedParamsEnd
 

BGL/include/CGAL/boost/graph/IO/VTK.h

@@ -393,7 +393,7 @@ void write_polys_points(std::ostream& os,
  *
  * \cgalNamedParamsBegin
  *   \cgalParamNBegin{use_binary_mode}
- *     \cgalParamDescription{indicates whether data should be written in binary (`true`) or in ASCII (`false`)}
+ *     \cgalParamDescription{indicates whether data should be written in binary (`true`) or in \ascii (`false`)}
  *     \cgalParamType{Boolean}
  *     \cgalParamDefault{`true`}
  *   \cgalParamNEnd
@@ -492,7 +492,7 @@ bool write_VTP(std::ostream& os,
  *
  * \cgalNamedParamsBegin
  *   \cgalParamNBegin{use_binary_mode}
- *     \cgalParamDescription{indicates whether data should be written in binary (`true`) or in ASCII (`false`)}
+ *     \cgalParamDescription{indicates whether data should be written in binary (`true`) or in \ascii (`false`)}
  *     \cgalParamType{Boolean}
  *     \cgalParamDefault{`true`}
  *   \cgalParamNEnd

BGL/include/CGAL/boost/graph/IO/polygon_mesh_io.h

@@ -214,7 +214,7 @@ bool read_polygon_mesh(const std::string& fname, Graph& g)
  *     \cgalParamDescription{a parameter used to set the precision (i.e. how many digits are generated) of the output stream}
  *     \cgalParamType{int}
  *     \cgalParamDefault{`6`}
- *     \cgalParamExtra{This parameter is only meaningful while using ASCII encoding.}
+ *     \cgalParamExtra{This parameter is only meaningful while using \ascii encoding.}
  *   \cgalParamNEnd
  *
  *   \cgalParamNBegin{verbose}

Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h

@@ -84,7 +84,7 @@ Orientation orientation();
 /*!
 This operator imports a general polygon from the input stream `in`.
 
-Both ASCII and binary formats are supported, and the format is automatically detected.
+Both \ascii and binary formats are supported, and the format is automatically detected.
 
 The format consists of the number of points of the outer boundary followed
 by the points themselves in counterclockwise order, followed by the number of holes,
@@ -100,11 +100,11 @@ std::istream& operator>>(std::istream& in, CGAL::General_polygon_2<ArrTraits>& P
 /*!
 This operator exports a general polygon to the output stream `out`.
 
-An ASCII and a binary format exist. The format can be selected with
+An \ascii and a binary format exist. The format can be selected with
 the \cgal modifiers for streams, `set_ascii_mode` and `set_binary_mode`
 respectively. The modifier `set_pretty_mode` can be used to allow for (a
 few) structuring comments in the output. Otherwise, the output would
-be free of comments. The default for writing is ASCII without
+be free of comments. The default for writing is \ascii without
 comments.
 
 The number of curves of the outer boundary is exported followed by the

Bounding_volumes/include/CGAL/Min_annulus_d.h

@@ -847,7 +847,7 @@ operator >> ( std::istream& is, CGAL::Min_annulus_d<Traits_>& min_annulus)
 
   case CGAL::IO::PRETTY:
     cerr << endl;
-    cerr << "Stream must be in ascii or binary mode" << endl;
+    cerr << "Stream must be in ASCII or binary mode" << endl;
     break;
 
   case CGAL::IO::ASCII:

Bounding_volumes/include/CGAL/Min_circle_2/Min_circle_2_adapterC2.h

@@ -309,7 +309,7 @@ operator >> ( std::istream& is,
 
       case CGAL::IO::PRETTY:
         std::cerr << std::endl;
-        std::cerr << "Stream must be in ascii or binary mode" << std::endl;
+        std::cerr << "Stream must be in ASCII or binary mode" << std::endl;
         break;
 
       case CGAL::IO::ASCII:

Bounding_volumes/include/CGAL/Min_circle_2/Min_circle_2_adapterH2.h

@@ -348,7 +348,7 @@ operator >> ( std::istream& is,
 
       case CGAL::IO::PRETTY:
         std::cerr << std::endl;
-        std::cerr << "Stream must be in ascii or binary mode" << std::endl;
+        std::cerr << "Stream must be in ASCII or binary mode" << std::endl;
         break;
 
       case CGAL::IO::ASCII:

Bounding_volumes/include/CGAL/Min_circle_2/Min_circle_2_impl.h

@@ -77,7 +77,7 @@ operator >> ( std::istream& is, CGAL::Min_circle_2<Traits_>& min_circle)
 
       case CGAL::IO::PRETTY:
         cerr << endl;
-        cerr << "Stream must be in ascii or binary mode" << endl;
+        cerr << "Stream must be in ASCII or binary mode" << endl;
         break;
 
       case CGAL::IO::ASCII:

Bounding_volumes/include/CGAL/Min_circle_2/Optimisation_circle_2_impl.h

@@ -60,7 +60,7 @@ operator >> ( std::istream& is, CGAL::Optimisation_circle_2<K_>& c)
 
       case CGAL::IO::PRETTY:
         std::cerr << std::endl;
-        std::cerr << "Stream must be in ascii or binary mode" << std::endl;
+        std::cerr << "Stream must be in ASCII or binary mode" << std::endl;
         break;
 
       case CGAL::IO::ASCII: {

Bounding_volumes/include/CGAL/Min_ellipse_2/Min_ellipse_2_adapterC2.h

@@ -378,7 +378,7 @@ operator >> ( std::istream& is,
 
       case CGAL::IO::PRETTY:
         std::cerr << std::endl;
-        std::cerr << "Stream must be in ascii or binary mode" << std::endl;
+        std::cerr << "Stream must be in ASCII or binary mode" << std::endl;
         break;
 
       case CGAL::IO::ASCII:

Bounding_volumes/include/CGAL/Min_ellipse_2/Min_ellipse_2_adapterH2.h

@@ -386,7 +386,7 @@ operator >> ( std::istream& is,
 
       case CGAL::IO::PRETTY:
         std::cerr << std::endl;
-        std::cerr << "Stream must be in ascii or binary mode" << std::endl;
+        std::cerr << "Stream must be in ASCII or binary mode" << std::endl;
         break;
 
       case CGAL::IO::ASCII:

Bounding_volumes/include/CGAL/Min_ellipse_2/Min_ellipse_2_impl.h

@@ -77,7 +77,7 @@ operator >> ( std::istream& is, CGAL::Min_ellipse_2<Traits_>& min_ellipse)
 
       case CGAL::IO::PRETTY:
         cerr << endl;
-        cerr << "Stream must be in ascii or binary mode" << endl;
+        cerr << "Stream must be in ASCII or binary mode" << endl;
         break;
 
       case CGAL::IO::ASCII:

Bounding_volumes/include/CGAL/Min_ellipse_2/Optimisation_ellipse_2_impl.h

@@ -79,7 +79,7 @@ operator >> ( std::istream& is, CGAL::Optimisation_ellipse_2<K_>& e)
 
       case CGAL::IO::PRETTY:
         std::cerr << std::endl;
-        std::cerr << "Stream must be in ascii or binary mode" << std::endl;
+        std::cerr << "Stream must be in ASCII or binary mode" << std::endl;
         break;
 
       case CGAL::IO::ASCII:

Bounding_volumes/include/CGAL/Min_sphere_d/Min_sphere_d_impl.h

@@ -77,7 +77,7 @@ operator >> ( std::istream& is, Min_sphere_d<Traits>& min_sphere)
 
       case IO::PRETTY:
         std::cerr << std::endl;
-        std::cerr << "Stream must be in ascii or binary mode" << std::endl;
+        std::cerr << "Stream must be in ASCII or binary mode" << std::endl;
         break;
 
       case IO::ASCII:

CGAL_ImageIO/include/CGAL/ImageIO.h

@@ -93,7 +93,7 @@ typedef enum {
 typedef enum {
   /** data are binary */
   DM_BINARY,
-  /** data are ascii */
+  /** data are \ascii */
   DM_ASCII
 } DATA_MODE;
 

CGAL_ImageIO/include/CGAL/ImageIO/gis.h

@@ -88,7 +88,7 @@ exemple :
    -a age (entier)
    -s sexe (1/2)
    -l lateralite
-   -txt texte libre (ascii)
+   -txt texte libre (ASCII)
    -endtxt (fin du texte)
 
 

CGAL_ImageIO/include/CGAL/ImageIO/gis_impl.h

@@ -109,19 +109,19 @@ int writeGis( char *name, _image* im) {
 
     switch( im->wordKind ) {
     default :
-      fprintf(stderr, "writeGis: such word kind not handled in ascii mode for file \'%s\'\n", outputName);
+      fprintf(stderr, "writeGis: such word kind not handled in ASCII mode for file \'%s\'\n", outputName);
       if ( outputName != nullptr ) ImageIO_free( outputName );
       return( -3 );
     case WK_FIXED :
       switch ( im->wdim ) {
       default :
-        fprintf(stderr, "writeGis: such word dim not handled in ascii mode for file \'%s\'\n", outputName);
+        fprintf(stderr, "writeGis: such word dim not handled in ASCII mode for file \'%s\'\n", outputName);
         if ( outputName != nullptr ) ImageIO_free( outputName );
         return( -3 );
       case 1 :
         switch ( im->sign ) {
         default :
-          fprintf(stderr, "writeGis: such sign not handled in ascii mode for file \'%s\'\n", outputName);
+          fprintf(stderr, "writeGis: such sign not handled in ASCII mode for file \'%s\'\n", outputName);
           if ( outputName != nullptr ) ImageIO_free( outputName );
           return( -3 );
         case SGN_UNSIGNED :
@@ -169,7 +169,7 @@ int writeGis( char *name, _image* im) {
       case 2 :
         switch ( im->sign ) {
         default :
-          fprintf(stderr, "writeGis: such sign not handled in ascii mode for file \'%s\'\n", outputName);
+          fprintf(stderr, "writeGis: such sign not handled in ASCII mode for file \'%s\'\n", outputName);
           if ( outputName != nullptr ) ImageIO_free( outputName );
           return( -3 );
         case SGN_UNSIGNED :
@@ -502,7 +502,7 @@ int readGisHeader( const char* name,_image* im)
 
 
 
-    /* read data if ascii
+    /* read data if ASCII
        only U8 and S8
      */
     if ( im->dataMode == DM_ASCII ) {
@@ -512,7 +512,7 @@ int readGisHeader( const char* name,_image* im)
       int ret, iv=0;
 
       if ( im->wdim != 1 || im->wordKind != WK_FIXED ) {
-        fprintf(stderr, "readGisHeader: error: unable to read such ascii type\n" );
+        fprintf(stderr, "readGisHeader: error: unable to read such ASCII type\n" );
         return -1;
       }
 
@@ -550,7 +550,7 @@ int readGisHeader( const char* name,_image* im)
           }
 
           if ( ret != 1 ) {
-            fprintf( stderr, "readGisHeader: error in reading ascii data\n" );
+            fprintf( stderr, "readGisHeader: error in reading ASCII data\n" );
             ImageIO_free( im->data ); im->data = nullptr;
             ImageIO_free( str );
             return -1;

CGAL_ImageIO/include/CGAL/ImageIO/pnm_impl.h

@@ -366,7 +366,7 @@ int readPgmAsciiImage(const char *name,_image *im)
       switch ( im->wordKind ) {
       case WK_FIXED :
         if ( sscanf( tmp, "%d", &iv ) != 1 ) {
-          fprintf( stderr, "readAsciiPgmImage: error in reading ascii data\n" );
+          fprintf( stderr, "readAsciiPgmImage: error in reading ASCII data\n" );
           ImageIO_free( im->data ); im->data = nullptr;
           return 0;
         }

Classification/include/CGAL/Classification/ETHZ/Random_forest_classifier.h

@@ -324,7 +324,7 @@ class Random_forest_classifier
   /// @{
 
   /*!
-    \brief converts a deprecated configuration (in compressed ASCII
+    \brief converts a deprecated configuration (in compressed \ascii
     format) to a new configuration (in binary format).
 
     The input file should be a GZIP container written by the

Classification/include/CGAL/Classification/Evaluation.h

@@ -333,7 +333,7 @@ class Evaluation
   /// @{
 
   /*!
-    \brief outputs the evaluation in a simple ASCII format to the stream `os`.
+    \brief outputs the evaluation in a simple \ascii format to the stream `os`.
   */
   friend std::ostream& operator<< (std::ostream& os, const Evaluation& evaluation)
   {

Documentation/doc/resources/1.8.13/BaseDoxyfile.in

@@ -237,6 +237,7 @@ ALIASES                = "cgal=%CGAL" \
                          "iso=ISO" \
                          "lisp=Lisp" \
                          "ieee=IEEE" \
+                         "ascii=ASCII" \
                          "exacus=Exacus" \
                          "mpir=MPIR" \
                          "mpfr=MPFR" \

Documentation/doc/resources/1.8.14/BaseDoxyfile.in

@@ -235,10 +235,11 @@ ALIASES                = "cgal=%CGAL" \
                          "stl=STL" \
                          "gmp=GMP" \
                          "gmpxx=GMPXX" \
-                         "exacus=Exacus" \
                          "iso=ISO" \
                          "lisp=Lisp" \
                          "ieee=IEEE" \
+                         "ascii=ASCII" \
+                         "exacus=Exacus" \
                          "mpir=MPIR" \
                          "mpfr=MPFR" \
                          "leda=LEDA" \