wonkily add names and so on

2 files changed, 27 insertions, 12 deletions

diff --git a/src/document_tree/elements.rs b/src/document_tree/elements.rs
index 5f669ae..638d44b 100644
--- a/src/document_tree/elements.rs
+++ b/src/document_tree/elements.rs
@@ -1,6 +1,7 @@
 use serde_derive::Serialize;
 
 use crate::target;
+use super::attribute_types::{ID,NameToken};
 use super::extra_attributes::{self,ExtraAttributes};
 use super::element_categories::*;
 
@@ -10,10 +11,15 @@ use super::element_categories::*;
 //-----------------\\
 
 pub trait Element {
-	fn     ids    (&    self) -> &    Vec<String>;
-	fn     ids_mut(&mut self) -> &mut Vec<String>;
-	fn   names    (&    self) -> &    Vec<String>;
-	fn   names_mut(&mut self) -> &mut Vec<String>;
+	/// A list containing one or more unique identifier keys
+	fn     ids    (&    self) -> &    Vec<ID>;
+	fn     ids_mut(&mut self) -> &mut Vec<ID>;
+	/// a list containing the names of an element, typically originating from the element's title or content.
+	/// Each name in names must be unique; if there are name conflicts (two or more elements want to the same name),
+	/// the contents will be transferred to the dupnames attribute on the duplicate elements.
+	/// An element may have at most one of the names or dupnames attributes, but not both.
+	fn   names    (&    self) -> &    Vec<NameToken>;
+	fn   names_mut(&mut self) -> &mut Vec<NameToken>;
 	fn  source    (&    self) -> &    Option<target::Target>;
 	fn  source_mut(&mut self) -> &mut Option<target::Target>;
 	fn classes    (&    self) -> &    Vec<String>;
@@ -22,11 +28,11 @@ pub trait Element {
 
 #[derive(Debug,Default,Serialize)]
 pub struct CommonAttributes {
-	ids:     Vec<String>,
-	names:   Vec<String>,
+	ids:     Vec<ID>,
+	names:   Vec<NameToken>,
 	source:  Option<target::Target>,
 	classes: Vec<String>,
-	//left out dupnames
+	//TODO: dupnames
 }
 
 //----\\
@@ -35,10 +41,10 @@ pub struct CommonAttributes {
 
 macro_rules! impl_element { ($name:ident) => (
 	impl Element for $name {
-		fn     ids    (&    self) -> &    Vec<String> { &    self.common.ids     }
-		fn     ids_mut(&mut self) -> &mut Vec<String> { &mut self.common.ids     }
-		fn   names    (&    self) -> &    Vec<String> { &    self.common.names   }
-		fn   names_mut(&mut self) -> &mut Vec<String> { &mut self.common.names   }
+		fn     ids    (&    self) -> &    Vec<ID>        { &    self.common.ids     }
+		fn     ids_mut(&mut self) -> &mut Vec<ID>        { &mut self.common.ids     }
+		fn   names    (&    self) -> &    Vec<NameToken> { &    self.common.names   }
+		fn   names_mut(&mut self) -> &mut Vec<NameToken> { &mut self.common.names   }
 		fn  source    (&    self) -> &    Option<target::Target> { &    self.common.source  }
 		fn  source_mut(&mut self) -> &mut Option<target::Target> { &mut self.common.source  }
 		fn classes    (&    self) -> &    Vec<String> { &    self.common.classes }
diff --git a/src/document_tree/extra_attributes.rs b/src/document_tree/extra_attributes.rs
index 0aa40f8..1799e4f 100644
--- a/src/document_tree/extra_attributes.rs
+++ b/src/document_tree/extra_attributes.rs
@@ -40,8 +40,11 @@ impl_extra!(DoctestBlock { space: FixedSpace });
 impl_extra!(SubstitutionDefinition { ltrim: bool, rtrim: bool });
 impl_extra!(Comment { space: FixedSpace });
 impl_extra!(Target {
+	/// External reference to a URI/URL
 	refuri: Option<target::Target>,
+	/// References to ids attributes in other elements
 	refid: Option<ID>,
+	/// Internal reference to the names attribute of another element. May resolve to either an internal or external reference.
 	refname: Vec<NameToken>,
 	anonymous: bool,
 });
@@ -71,9 +74,12 @@ impl_extra!(Table {}); //TODO
 impl_extra!(OptionArgument { delimiter: Option<String> });
 
 impl_extra!(Reference {
-	name: Option<String>,
+	name: Option<NameToken>,  //TODO: is CDATA in the DTD, so maybe no nametoken?
+	/// External reference to a URI/URL
 	refuri: Option<target::Target>,
+	/// References to ids attributes in other elements
 	refid: Option<ID>,
+	/// Internal reference to the names attribute of another element
 	refname: Vec<NameToken>,
 });
 impl_extra!(FootnoteReference { refid: Option<ID>, refname: Vec<NameToken>, auto: bool });
@@ -83,8 +89,11 @@ impl_extra!(Problematic { refid: Option<ID> });
 
 //also have non-inline versions. Inline image is no figure child, inline target has content
 impl_extra!(TargetInline {
+	/// External reference to a URI/URL
 	refuri: Option<target::Target>,
+	/// References to ids attributes in other elements
 	refid: Option<ID>,
+	/// Internal reference to the names attribute of another element. May resolve to either an internal or external reference.
 	refname: Vec<NameToken>,
 	anonymous: bool,
 });