diff --git a/CHANGES.rst b/CHANGES.rst index 4fe8726..e31a18c 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,10 +1,16 @@ -********************* -PRISMH Change History -********************* +******************* +RIOS Change History +******************* -0.1.0 (2015-xx-xx) +0.2.0 (2015-xx-xx) ================== -* Initial publication for review. +* Changed name of standard to RIOS - Research Instrument Open Standard + + +0.1.0 (2015-08-24) +================== + +* Initial publication of PRIMSH for review. diff --git a/README.rst b/README.rst index d3321e6..2e53ad3 100644 --- a/README.rst +++ b/README.rst @@ -1,22 +1,22 @@ -.. image:: https://readthedocs.org/projects/prismh-specification/badge/?version=latest - :target: https://prismh-specification.readthedocs.org +.. image:: https://readthedocs.org/projects/rios/badge/?version=latest + :target: https://rios.readthedocs.org :alt: Documentation Status -**************************************************************** -PRISMH - Portable Research Instrument Standard for Mental Health -**************************************************************** +**************************************** +RIOS - Research Instrument Open Standard +**************************************** Overview ======== -This repository contains the source materials needed to produce the PRISMH +This repository contains the source materials needed to produce the RIOS documentation site and specifications. Contributing ============ -Contributions to the PRISMH specifications or this site specifically must be +Contributions to the RIOS specifications or this site specifically must be made by forking this repository, implementing your desired changes, and then submitting a Pull Request back to the project. @@ -32,7 +32,7 @@ that is included in this repository. .. _`Python`: https://www.python.org/ -Assuming the reccommended toolset is available, the full PRISMH site can be +Assuming the reccommended toolset is available, the full RIOS site can be generated by executing ``make html`` within the ``/docs/`` directory in this repository. The output will be placed in ``/docs/build/html``. diff --git a/docs/Makefile b/docs/Makefile index 4331e65..35661d1 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -87,9 +87,9 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PRISMH.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/RIOS.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PRISMH.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/RIOS.qhc" applehelp: $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp @@ -104,8 +104,8 @@ devhelp: @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/PRISMH" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PRISMH" + @echo "# mkdir -p $$HOME/.local/share/devhelp/RIOS" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/RIOS" @echo "# devhelp" epub: diff --git a/docs/source/assessment_specification.rst b/docs/source/assessment_specification.rst index 7c0255c..293ea9c 100644 --- a/docs/source/assessment_specification.rst +++ b/docs/source/assessment_specification.rst @@ -7,7 +7,7 @@ Assessment Document Specification Overview ======== -A PRISMH Assessment Document is a standard means to represent a set of values +A RIOS Assessment Document is a standard means to represent a set of values that fulfill the requirements described in a corresponding :doc:`Instrument Definition `. diff --git a/docs/source/calculation_set_specification.rst b/docs/source/calculation_set_specification.rst index 21a34b1..f886d50 100644 --- a/docs/source/calculation_set_specification.rst +++ b/docs/source/calculation_set_specification.rst @@ -7,7 +7,7 @@ Calculation Set Definition Specification Overview ======== -A PRISMH Calculation Set Definition is a standard means to represent a set of +A RIOS Calculation Set Definition is a standard means to represent a set of calculations that can be applied to the data collected in an :doc:`Assessment Document ` for a given :doc:`Instrument Definition `. diff --git a/docs/source/conf.py b/docs/source/conf.py index 3095842..d4a1016 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# PRISMH documentation build configuration file, created by +# RIOS documentation build configuration file, created by # sphinx-quickstart on Mon Mar 23 11:15:25 2015. # # This file is execfile()d with the current directory set to its @@ -52,7 +52,7 @@ master_doc = 'index' # General information about the project. -project = u'PRISMH' +project = u'RIOS' copyright = u'2015, Prometheus Research, LLC' author = u'Prometheus Research, LLC' @@ -61,9 +61,9 @@ # built documents. # # The short X.Y version. -version = '0.1.0' +version = '0.2.0' # The full version, including alpha/beta/rc tags. -release = '0.1.0' +release = '0.2.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -206,7 +206,7 @@ #html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'PRISMHdoc' +htmlhelp_basename = 'RIOSdoc' # -- Options for LaTeX output --------------------------------------------- @@ -228,7 +228,7 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'PRISMH.tex', u'PRISMH Documentation', + (master_doc, 'RIOS.tex', u'RIOS Documentation', u'Prometheus Research, LLC', 'manual'), ] @@ -258,7 +258,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'prismh', u'PRISMH Documentation', + (master_doc, 'rios', u'RIOS Documentation', [author], 1) ] @@ -272,8 +272,8 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'PRISMH', u'PRISMH Documentation', - author, 'PRISMH', 'One line description of project.', + (master_doc, 'RIOS', u'RIOS Documentation', + author, 'RIOS', 'Research Instrument Open Standard', 'Miscellaneous'), ] diff --git a/docs/source/examples/alltypes-form.json b/docs/source/examples/alltypes-form.json index 8cc1e87..5b6b068 100644 --- a/docs/source/examples/alltypes-form.json +++ b/docs/source/examples/alltypes-form.json @@ -6,7 +6,7 @@ "defaultLocalization": "en", "title": { - "en": "All PRISMH Data Types" + "en": "All RIOS Data Types" }, "pages": [ diff --git a/docs/source/examples/alltypes.rst b/docs/source/examples/alltypes.rst index 504b940..cad5ecb 100644 --- a/docs/source/examples/alltypes.rst +++ b/docs/source/examples/alltypes.rst @@ -9,7 +9,7 @@ Overview ======== The following examples illustrate an Instrument that contains fields of every -data type supported by the PRISMH specification. It is accompanied by a Web +data type supported by the RIOS specification. It is accompanied by a Web Form that is broken up into several pages and uses all available element types. diff --git a/docs/source/index.rst b/docs/source/index.rst index 198f695..4476d34 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,9 +1,9 @@ -**************************************************************** -PRISMH - Portable Research Instrument Standard for Mental Health -**************************************************************** +**************************************** +RIOS - Research Instrument Open Standard +**************************************** Welcome! This site is the home of the documentation and specifications around -**PRISMH**, the Portable Research Instrument Standard for Mental Health. +**RIOS**, the Research Instrument Open Standard. Introduction diff --git a/docs/source/instrument_specification.rst b/docs/source/instrument_specification.rst index 1fff9fa..cd813c0 100644 --- a/docs/source/instrument_specification.rst +++ b/docs/source/instrument_specification.rst @@ -7,7 +7,7 @@ Instrument Definition Specification Overview ======== -A PRISMH Instrument Definition is a standard means to represent a set of data +A RIOS Instrument Definition is a standard means to represent a set of data that must are to be collected about a subject. It is intended to define **what** data is to be collected, not necessarily **how** that data is collected. diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 6e7ba96..a8a789e 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -8,7 +8,7 @@ Overview Introduction ============ -The PRISMH specification describe a collection of configuration files that are +The RIOS specification describe a collection of configuration files that are used to define the process of data collection in an open and transportable way. @@ -18,7 +18,7 @@ Major Components Instrument ---------- :doc:`Instrument Definition ` are the base of the -PRISMH specification. They contain the definition of **what** data is to be +RIOS specification. They contain the definition of **what** data is to be collected. At its heart, it is a list of field definitions that specify the name, data type, and type constraints. There is no information or instruments on **how** the data is to be retrieved or collected -- only **what** data needs diff --git a/docs/source/sms_interaction_specification.rst b/docs/source/sms_interaction_specification.rst index 28daf7e..7d049a0 100644 --- a/docs/source/sms_interaction_specification.rst +++ b/docs/source/sms_interaction_specification.rst @@ -7,7 +7,7 @@ SMS Interaction Configuration Specification Overview ======== -A PRISMH SMS Interaction Configuration is a standard means to augment an +A RIOS SMS Interaction Configuration is a standard means to augment an :doc:`Instrument Definition ` with additional configuration and meta-data that allows the Instrument to be administered via an SMS text message-based application. diff --git a/docs/source/web_form_specification.rst b/docs/source/web_form_specification.rst index 8562856..80d0c73 100644 --- a/docs/source/web_form_specification.rst +++ b/docs/source/web_form_specification.rst @@ -7,7 +7,7 @@ Web Form Configuration Specification Overview ======== -A PRISMH Web Form Configuration is a standard means to augment an +A RIOS Web Form Configuration is a standard means to augment an :doc:`Instrument Definition ` with additional configuration and meta-data that allows the Instrument to be administered via a web-based application.