Merge pull request #33 from bids-standard/master

update 1/24

Pipfile

@@ -6,6 +6,7 @@ name = "pypi"
 [packages]
 mkdocs = "==1.0.4"
 mkdocs-material = "==4.1.2"
+mkdocs-branchcustomization-plugin = "~=0.1.3"
 
 [dev-packages]
 

README.md

@@ -11,8 +11,29 @@ organisation of neuroimaging data.
 In this repository, we develop the
 [BIDS specification](https://bids-specification.readthedocs.io/en/latest/).
 
-**Want to learn more about working with BIDS? Have a question, comment, or suggestion?**
-Open or comment on one of our [NeuroStars issues](https://neurostars.org/tags/bids) or check out the [BIDS Starter Kit](https://github.com/bids-standard/bids-starter-kit)!
+# When to use BIDS
+
+To organize your data in BIDS, all you need is neuro data, a computer, and the
+[BIDS specification](https://bids-specification.readthedocs.io/en/stable/).
+
+BIDS currently supports MRI, MEG, EEG, iEEG, behavioral, and physiological data
+and more modalities will be added.
+
+# Formatting your data with BIDS
+
+As a dataset curator, the GitHub repository and all files therein can be safely ignored.
+Users should focus on [the rendered content](https://bids-specification.readthedocs.io/en/stable/).
+The specification is provided in the form of a webpage, built using
+[MkDocs](https://www.mkdocs.org/) and [Read the Docs](https://readthedocs.org/).
+
+*Want to learn more about working with BIDS? Have a question, comment, or suggestion?*
+
+1. Read some introductory material, most likely the very basic problems have already been addressed!
+  - [BIDS Starter Kit](https://github.com/bids-standard/bids-starter-kit) for tutorials, wikis, templates, ...
+2. Post your question in one of several channels where BIDS members are active
+  - the [NeuroStars](https://neurostars.org/tags/bids) discourse forum
+  - the [Google group](https://groups.google.com/forum/#!forum/bids-discussion), for broader discussions surrounding BIDS
+  - the [specification repository issue page](https://github.com/bids-standard/bids-specification/issues), if you found inconsistencies, typos, or other issues with the BIDS specification itself
 
 # Contributing to BIDS
 

mkdocs.yml

@@ -11,6 +11,11 @@ markdown_extensions:
         anchorlink: true
 plugins:
     - search
+    - branchcustomization:
+        update_config:
+         - branch: /(?!^master$)/
+           +extra_css:
+             - css/watermark.css
 docs_dir: 'src'
 use_directory_urls: false
 nav:

requirements.txt

@@ -1 +1,2 @@
-mkdocs-material
+mkdocs-material
+mkdocs-branchcustomization-plugin ~= 0.1.3

src/01-introduction.md

@@ -46,8 +46,7 @@ different backgrounds.
 
 The BIDS specification can be extended in a backwards compatible way and will
 evolve over time. This is accomplished through community-driven BIDS Extension
-Proposals (BEPs). For more information about the BEP process, and list of
-current BEP proposals, see
+Proposals (BEPs). For more information about the BEP process, see
 [Extending the BIDS specification](06-extensions.md).
 
 ## Citing BIDS

src/02-common-principles.md

@@ -152,8 +152,8 @@ my_dataset/
     ...
 ```
 
-In this example **only the `rawdata` subfolder needs to be BIDS compliant**
-dataset. This specification does not prescribe anything about the contents of
+In this example **only the `rawdata` subfolder needs to be a BIDS compliant
+dataset**. This specification does not prescribe anything about the contents of
 `sourcedata` and `derivatives` folders in the above example - nor does it
 prescribe the `sourcedata`, `derivatives`, or `rawdata` folder names. The above
 example is just a convention that can be useful for organizing raw, source, and
@@ -218,7 +218,7 @@ apply to different runs and rec files. Also if the JSON file
 (`task-xyz_acq-test1_bold.json`) is defined at dataset top level directory, it
 will be applicable to all task runs with `test1` acquisition parameter.
 
-Example 3: Multiple json files at different levels for same task and acquisition parameters
+Example 3: Multiple JSON files at different levels for same task and acquisition parameters
 
 ```Text
 task-xyz_acq-test1_bold.json
@@ -236,7 +236,7 @@ at the top directory will apply to all bold runs. However, if there is a key
 with different value in the
 `sub-01/func/sub-01_task-xyz_acq-test1_bold.json` file defined at a
 deeper level, that value will be applicable for that particular run/task NIfTI
-file/s. In other words, the `json` file at the deeper level overrides values
+file/s. In other words, the `.json` file at the deeper level overrides values
 that are potentially also defined in the `.json` at a more shallow level. If the
 `.json` file at the more shallow level contains key-value-pairs that are not
 present in the `.json` file at the deeper level, these key-value-pairs are
@@ -271,7 +271,7 @@ NIfTI header.
 
 ### Tabular files
 
-Tabular data MUST be saved as tab delimited values (`.tsv`) files, i.e., csv
+Tabular data MUST be saved as tab delimited values (`.tsv`) files, i.e., CSV
 files where commas are replaced by tabs. Tabs MUST be true tab characters and
 MUST NOT be a series of space characters. Each TSV file MUST start with a header
 line listing the names of all columns (with the exception of physiological and
@@ -389,7 +389,7 @@ Describing dates and timestamps:
 -   Time stamp information MUST be expressed in the following format: `13:45:30`
 
 -   Dates can be shifted by a random number of days for privacy protection
-    reasons. To distinguish real dates from shifted dates always use year 1900
+    reasons. To distinguish real dates from shifted dates always use year 1925
     or earlier when including shifted years. For longitudinal studies please
     remember to shift dates within one subject by the same number of days to
     maintain the interval information. Example: `1867-06-15T13:45:30`