Merge pull request #628 from DILCISBoard/rel/v2.0

Release v2.0.4

.gitignore

@@ -1,6 +1,6 @@
 # Site publication file
-# docs/
-
+docs/
+site/
 Gemfile.lock
 **/_site
 

.travis.yml

@@ -3,39 +3,30 @@ sudo: required
 language: java
 jdk:
   - openjdk8
-before_install:
-  - sudo apt-get update
-  - sudo apt-get install -y texlive texlive-base texlive-latex-extra texlive-fonts-extra
-    python-virtualenv librsvg2-bin
-  - wget https://github.com/jgm/pandoc/releases/download/2.5/pandoc-2.5-linux.tar.gz
-  - tar -xzvf pandoc-2.5-linux.tar.gz
-  - rm pandoc-2.5-linux.tar.gz
-  - sudo mv pandoc-2.5 /opt
-  - sudo chmod +x /opt/pandoc-2.5/bin/pandoc
-  - sudo ln -s /opt/pandoc-2.5/bin/pandoc /usr/local/bin/pandoc
-  - sudo ln -s /opt/pandoc-2.5/bin/pandoc-citeproc /usr/local/bin/pandoc-citeproc
 script:
   - cd spec-publisher
   - mvn clean package
   - java -jar target/mets-profile-proc.jar ../profile/E-ARK-CSIP.xml
   - cd ..
   - docker run -it --rm -v "$PWD:/source" -u "$(id -u):$(id -g)" --entrypoint /source/create-site.sh eark4all/spec-pdf-publisher
-  - bundle install
-  - bundle exec jekyll build -s ./docs -d ./_site
-  - bundle exec htmlproofer ./_site --file-ignore /javadoc/ --only-4xx --check-html
   - cd spec-publisher
+  - git stash
   - git checkout feat/pdf-publication
   - mvn clean package
   - java -jar target/mets-profile-proc.jar ../profile/E-ARK-CSIP.xml
   - cd ..
-  - bash create-pdf.sh
+  - docker run -it --rm -v "$PWD:/source" -u "$(id -u):$(id -g)" --entrypoint /source/create-pdf.sh eark4all/spec-pdf-publisher
+  - mkdir site
+  - docker run -it --rm -v "$PWD"/docs:/usr/src/app -v "$PWD"/site:/_site -u "$(id -u):$(id -g)" starefossen/github-pages jekyll build -d /_site
+  - bundle install
+  - bundle exec htmlproofer ./site --file-ignore /javadoc/ --only-4xx --check-html
 deploy:
   provider: pages
   skip_cleanup: true
   github_token: "$GH_TOKEN"
   keep_history: true
-  local_dir: docs
-  fqdn: earkcsip.dilcis.eu
+  local_dir: site
+  fqdn: "$CNAME"
   on:
     branch: master
 env:

BASE.md

@@ -13,6 +13,8 @@
 
 !INCLUDE "specification/implementation/structure/folders/index.md"
 
+!INCLUDE "specification/implementation/structure/folders/structure.md"
+
 !INCLUDE "specification/implementation/structure/implementation/index.md"
 
 !INCLUDE "specification/implementation/metadata/index.md"

Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 gem 'github-pages', group: :jekyll_plugins
-gem "jekyll-theme-primer", group: :jekyll_plugin
 gem 'html-proofer'

RELEASENOTES.md

@@ -0,0 +1,142 @@
+---
+title: Release Notes
+---
+
+RELEASE NOTES
+=============
+
+Categories of specification change
+-----------------------------------
+
+### Major
+Changes are not backwardly compatible with previous versions.
+A new major version, e.g. from 2.x.y to 3.0.0
+
+### Minor
+Backward compatible changes with the current major version.
+Often a new feature or extension.
+
+### Corrections
+Corrections and improvements to grammar and spelling, not intended
+to change the meaning of the specification.
+
+### Administrative:
+Standard changes between versions, e.g. version number and release date.
+
+Version 2.0.4
+-------------
+June 12th 2020
+
+### Specification Changes
+
+#### Major
+None
+
+#### Minor
+None
+
+#### Corrections
+- Image updates [[#610][], [#622][], [#623][]]
+- CSIP45 spelling error [[#603][]]
+- ID update in example referencing check [[#602][]]
+- Update of images due to the change of name of the geodata specification [[#593][], [#599][]]
+- Update of the common introduction text in the specifications [[#592][]]
+- METS profile appendix elements ID's needs to be unique [[#591][], [#606][]]
+- Error in attribute name in CSIP91 [[#587][], [#594][], [#597][]]]
+- Update ID's in the METs profile appendixes. [[#585][], [#606][]]
+- General Text improvement [[#556][], [#611][]-[#619][], [#621][]]
+- MAJOR case inconsistency between text and figures [[#555][], [#608][]]
+- CSIP2 - more direct link to vocabulary would benefit understanding [[#446][]]
+- Inconsistency - use singular or plural terms in the vocabulary [[#445][]]
+- Review use of word component. [[#444][]]
+- CSIP64 fileGrp/USE one-word categories instead of full folder path [[#435][]]
+- Update examples to use short IDs [[#428][], [#596][]]
+- Purpose of CSIP structMap [[#426][]]
+- Extension schema name and path [[#415][]]
+- xlink:href relative to root IP or representation? [[#406][]]
+- Testability of @xlink:href attribute in METS [[#398][]]
+- Clarification of use of METS [[#368][]]
+- Xlink namespace in examples [[#337][]]
+- Showing version of CS IP used  [[#325][]]
+- Consistency of case in section II, 5.3.6 [[#316][]]
+- Filepaths in section II, 5.3.4 [[#306][]]
+- Content of folder metadata, section II, 4.1 [[#][291]]
+- Typo in section 5.3.3.  [[#257][]]
+- CSIPSTR16: There is no mention of Representation Information. We should add this to the examples. [[#252][], [#595][]]
+- Namespaces in examples mets Root [[#194][]]
+
+#### Administrative
+- Bumped version and updated release date [[#598][], [#601][]]
+- Make sure all releases are tagged [[#590][]]
+
+### Web site and PDF presentation
+- CSIP45 links dont become links [[#609][], [#624][]]
+- Uniform site structure and DILCIS branding [[#605][]]:
+  + Offer uniform access to pdf versions [[#589][], [#600][]]
+  + Add link to pdf in the html version [[#588][], [#600][]]
+- Full Examples [[#566][]m [#625][]]
+- Appendix C: A Full List of E-ARK CSIP Requirements (the list is not full) [[#374][], [#604][]]
+- Layout enhancements in section II, 5.3.1 and so on [[#297][]]
+
+[#625]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/625
+[#624]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/624
+[#623]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/623
+[#622]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/622
+[#621]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/621
+[#619]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/619
+[#618]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/618
+[#617]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/617
+[#616]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/616
+[#615]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/615
+[#614]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/614
+[#613]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/613
+[#612]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/612
+[#611]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/611
+[#608]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/608
+[#606]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/606
+[#604]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/605
+[#604]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/604
+[#601]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/601
+[#600]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/600
+[#599]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/599
+[#598]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/598
+[#597]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/597
+[#596]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/596
+[#595]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/595
+[#594]: https://github.com/DILCISBoard/E-ARK-CSIP/pull/594
+
+[#610]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/610
+[#609]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/609
+[#603]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/603
+[#602]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/602
+[#593]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/593
+[#592]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/592
+[#591]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/591
+[#590]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/590
+[#589]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/589
+[#588]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/588
+[#587]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/587
+[#585]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/585
+[#566]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/566
+[#556]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/556
+[#555]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/555
+[#446]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/446
+[#445]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/445
+[#444]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/444
+[#435]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/435
+[#428]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/428
+[#426]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/426
+[#415]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/415
+[#406]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/406
+[#398]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/398
+[#374]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/374
+[#368]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/368
+[#337]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/337
+[#325]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/325
+[#316]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/316
+[#306]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/306
+[#297]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/297
+[#291]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/291
+[#257]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/257
+[#252]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/252
+[#194]: https://github.com/DILCISBoard/E-ARK-CSIP/issues/194

archive/index.md

@@ -4,6 +4,19 @@ title: Archived Versions of the Common Specification
 Archived Versions of the Common Specification
 =============================================
 
-- [Version 2.0.0](v2_0/eark-csip-v2-0-0.pdf)
-- [Version 1.1](v1_1/Introduction to common specifications for IPs v1_1.docx)
-- [Version 1.0](v1_0/Common_Specifications_for_IPs_v10.pdf)
+Latest
+------
+[PDF Version 2.0.4](/pdf/eark-csip.pdf) 12-06-2020
+
+Archived Versions
+-----------------
+### 2.0.x
+- [PDF Version 2.0.3](v2_0/eark-csip-v2-0-3.pdf) 08-01-2020
+- [PDF Version 2.0.2](v2_0/eark-csip-v2-0-2.pdf) 28-10-2019
+- [PDF Version 2.0.1](v2_0/eark-csip-v2-0-1.pdf) 09-09-2019
+- [PDF Version 2.0.0](v2_0/eark-csip-v2-0-0.pdf) 31-05-2019
+
+### 1.x
+-----------
+- [WORD Version 1.1](v1_1/Introduction to common specifications for IPs v1_1.docx) 14-05-2018
+- [PDF Version 1.0](v1_0/Common_Specifications_for_IPs_v10.pdf) 01-02-2017

create-site.sh

@@ -15,6 +15,12 @@ then
   rm -rf ./docs/figs
 fi
 
+if [ -d ./docs/pdf ]
+then
+  echo " - removing existing pdf directory"
+  rm -rf ./docs/pdf]
+fi
+
 if [ -d ./docs/profile ]
 then
   echo " - removing existing profile directory"
@@ -33,6 +39,44 @@ then
   rm -rf ./docs/archive
 fi
 
+if [ -d ./docs/_data ]
+then
+  echo " - removing existing menu data"
+  rm -rf ./docs/_data
+fi
+
+if [ -d ./docs/_includes ]
+then
+  echo " - removing existing includes"
+  rm -rf ./docs/_includes
+fi
+
+if [ -d ./docs/_layouts ]
+then
+  echo " - removing existing layouts"
+  rm -rf ./docs/_layouts
+fi
+
+if [ -d ./docs/img ]
+then
+  echo " - removing existing images"
+  rm -rf ./docs/img
+fi
+
+if [ -d ./docs/css ]
+then
+  echo " - removing existing css"
+  rm -rf ./docs/css
+fi
+
+if [ -d ./docs/release-notes ]
+then
+  echo " - removing existing release notes"
+  rm -rf ./docs/release-notes
+fi
+mkdir ./docs/release-notes
+cp ./RELEASENOTES.md ./docs/release-notes/index.md
+
 bash "$SCRIPT_DIR/spec-publisher/utils/create-venv.sh"
 
 command -v markdown-pp >/dev/null 2>&1 || {
@@ -49,6 +93,8 @@ markdown-pp SITE.md -o ./docs/index.md
 echo " - copying files to docs directory"
 cp -R specification/figs docs/
 cp -R spec-publisher/res/md/figs docs/
+cp -Rf spec-publisher/site/* docs/
 cp -R profile docs/
 cp -R schema docs/
 cp -R archive docs/
+cp -R examples docs/