From 3271d0f364efdafda70ba588a7c83e20c70e310a Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jean-Christophe=20Beaupr=C3=A9?= Date: Fri, 12 Dec 2014 14:07:15 -0500 Subject: [PATCH] nitdoc: Document constraints on `nitdoc_id`. MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jean-Christophe Beaupré --- src/doc/doc_model.nit | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/doc/doc_model.nit b/src/doc/doc_model.nit index 12fbf72..3a560f5 100644 --- a/src/doc/doc_model.nit +++ b/src/doc/doc_model.nit @@ -35,7 +35,15 @@ redef class MEntity # HTML Escaped name fun nitdoc_name: String is abstract - # Used as HTML unique ids + # ID used as a HTML unique ID and in file names. + # + # **Must** match the following (POSIX ERE) regular expression: + # + # ~~~POSIX ERE + # ^[A-Za-z_][A-Za-z0-9._-]*$ + # ~~~ + # + # That way, the ID is always a valid URI component and a valid XML name. fun nitdoc_id: String is abstract # URL of this entity’s Nitdoc page. -- 1.7.9.5