Merge remote-tracking branch 'origin/register-dois' into new-manual

src/adjmat/AdjacencyMatrixBase.cpp

@@ -43,6 +43,7 @@ void AdjacencyMatrixBase::registerKeywords( Keywords& keys ) {
  keys.addOutputComponent("y","COMPONENTS","matrix","the projection of the bond on the y axis");
  keys.addOutputComponent("z","COMPONENTS","matrix","the projection of the bond on the z axis");
  keys.setValueDescription("matrix","a matrix containing the weights for the bonds between each pair of atoms");
+ keys.addDOI("https://doi.org/10.1021/acs.jctc.6b01073");
 }
 
 AdjacencyMatrixBase::AdjacencyMatrixBase(const ActionOptions& ao):

src/cltools/GenJson.cpp

@@ -123,6 +123,14 @@ int GenJson::main(FILE* in, FILE*out,Communicator& pc) {
  // Now output keyword information
  Keywords keys; actionRegister().getKeywords( action_names[i], keys );
  std::cout<<" \"displayname\" : \""<<keys.getDisplayName()<<"\",\n";
+ //
+ std::cout<<" \"dois\" : [";
+ unsigned ndoi = keys.getDOIList().size();
+ if( ndoi>0 ) {
+ std::cout<<"\"" + keys.getDOIList()[0] + "\"";
+ for(unsigned j=1; j<ndoi; ++j) std::cout<<", \"" + keys.getDOIList()[j] + "\"";
+ }
+ std::cout<<"],\n";
  std::cout<<" \"syntax\" : {"<<std::endl;
  for(unsigned j=0; j<keys.size(); ++j) {
  std::string defa = "", desc = keys.getKeywordDescription( keys.getKeyword(j) );

src/clusters/ClusteringBase.cpp

@@ -28,6 +28,7 @@ namespace clusters {
 void ClusteringBase::registerKeywords( Keywords& keys ) {
  matrixtools::MatrixOperationBase::registerKeywords( keys );
  keys.setValueDescription("vector","vector with length that is equal to the number of rows in the input matrix. Elements of this vector are equal to the cluster that each node is a part of");
+ keys.addDOI("https://doi.org/10.1021/acs.jctc.6b01073");
 }
 
 ClusteringBase::ClusteringBase(const ActionOptions&ao):

src/tools/Keywords.cpp

@@ -776,4 +776,12 @@ std::string Keywords::getDisplayName() const {
  return thisactname;
 }
 
+void Keywords::addDOI( const std::string& doi ) {
+ doilist.push_back( doi );
+}
+
+const std::vector<std::string>& Keywords::getDOIList() const {
+ return doilist;
+}
+
 }

src/tools/Keywords.h

@@ -98,6 +98,8 @@ class Keywords {
  std::vector<std::string> neededActions;
 /// List of suffixes that can be used with this action
  std::vector<std::string> actionNameSuffixes;
+/// List of doi's that should appear in the manual
+ std::vector<std::string> doilist;
 /// Print the documentation for the jth keyword in html
  void print_html_item( const std::string& ) const;
 public:
@@ -217,6 +219,10 @@ class Keywords {
  std::string getDisplayName() const ;
 /// Set the display name
  void setDisplayName( const std::string& name );
+/// Add a DOI to the list in the manual page for this action
+ void addDOI( const std::string& doi );
+/// Get the list of DOI
+ const std::vector<std::string>& getDOIList() const ;
 };
 
 }