{"id":39497243,"url":"https://github.com/clarin-eric/fcs-misc","last_synced_at":"2026-01-18T05:44:08.098Z","repository":{"id":144999026,"uuid":"513114984","full_name":"clarin-eric/fcs-misc","owner":"clarin-eric","description":"Specification documents, examples and schema files","archived":false,"fork":false,"pushed_at":"2025-11-17T09:58:50.000Z","size":66493,"stargazers_count":1,"open_issues_count":1,"forks_count":2,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-11-17T11:27:42.460Z","etag":null,"topics":["asciidoc","clarin","fcs","specifications","xsd"],"latest_commit_sha":null,"homepage":"https://www.clarin.eu/content/federated-content-search-clarin-fcs-technical-details","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/clarin-eric.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-07-12T11:28:39.000Z","updated_at":"2025-11-17T09:58:56.000Z","dependencies_parsed_at":"2025-06-24T14:33:55.827Z","dependency_job_id":null,"html_url":"https://github.com/clarin-eric/fcs-misc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/clarin-eric/fcs-misc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarin-eric%2Ffcs-misc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarin-eric%2Ffcs-misc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarin-eric%2Ffcs-misc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarin-eric%2Ffcs-misc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/clarin-eric","download_url":"https://codeload.github.com/clarin-eric/fcs-misc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/clarin-eric%2Ffcs-misc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28531375,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asciidoc","clarin","fcs","specifications","xsd"],"created_at":"2026-01-18T05:43:28.323Z","updated_at":"2026-01-18T05:44:08.090Z","avatar_url":"https://github.com/clarin-eric.png","language":"Java","funding_links":[],"categories":["Specification Documents"],"sub_categories":[],"readme":"# FCS Miscellaneous Resources\n\nThis repo contains AsciiDoc sources, images, examples and schema files for the CLARIN Federated Content Search (FCS) specification documents found at [clarin.eu](https://www.clarin.eu/content/federated-content-search-clarin-fcs-technical-details). Prior versions of the specification documents with examples and schema files are also backed up in the [`historical/`](historical/) folder. Current builds of the AsciiDoc sources are available [on this page](https://clarin-eric.github.io/fcs-misc/).\n\nJump to: [[Specification Documents](#specification-documents)]\n| [[Tutorial Documents](#tutorial-documents)]\n| [[Historical Resources](#historical-resources)]\n| [[Webpage with Builds](#webpage-with-builds)]\n\n## Specification Documents\n\n- [CLARIN Federated Content Search - FCS **Core 2.0**: `fcs-core-2.0/index.adoc`](fcs-core-2.0/index.adoc)\n- [CLARIN Federated Content Search - FCS **Core 1.0**: `fcs-core-1.0/index.adoc`](fcs-core-1.0/index.adoc)\n- [CLARIN Federated Content Search - FCS **Data Views 1.0**: `fcs-dataviews-1.0/index.adoc`](fcs-dataviews-1.0/index.adoc)\n- _WIP_ [CLARIN Federated Content Search - FCS **AAI 1.0**: `fcs-aai/index.adoc`](fcs-aai/index.adoc)\n- _WIP_ [Text+ **LexFCS 1.0**: `lexfcs/index.adoc`](lexfcs/index.adoc) _(Mirror of [Text+ Gitlab Repo](https://gitlab.gwdg.de/textplus/ag-fcs-documents))_\n\n### Folder Structure\n\nAll the specification documents are structured as follows in their sub folders:\n- `index.adoc` -- AsciiDoc entrypoint document that bundles and includes single chapters into one\n- `attachments/` -- (optional) with schema files or similar\n- `examples/` -- (optional) examples (or fragments) that are included in the specification document\n- `images/` -- (optional) for images that will be in the specification\n- `themes/` -- links to the global [`themes/`](themes/) folder with the `clarin` theme\n\n### AsciiDoc\n\n* global [`themes/`](themes/) folder for CLARIN\n\n### How to build\n\nPlease take a look at the [Github Actions workflow definitions in `.github/workflows`](.github/workflows). All the specification documents will be built automatically when their source files change. (_NOTE: changes to theme files may require manually triggering the build._)\n\nYou can build the specifications documents yourself with:\n\n```bash\n# Set spec you want to build\n# Based on folder names, choose one of: fcs-core-1.0, fcs-core-2.0, fcs-aai, fcs-dataviews-1.0\nNAME=fcs-core-2.0\n\n# Output will be placed in `docs/`\n\n# Build HTML\nasciidoctor -v -D docs -a data-uri --backend=html5 -o ${NAME}.html ${NAME}/index.adoc\n\n# Build PDF\nasciidoctor-pdf -v -D docs -o ${NAME}.pdf ${NAME}/index.adoc\n\n# (optional) Copy attachments\ncp -R ${NAME}/attachments docs/\n\n# (optional) Copy examples (are already included into the documents)\ncp -R ${NAME}/examples docs/\n```\n\nYou can use the [`asciidoctor/docker-asciidoctor` docker image](https://github.com/asciidoctor/docker-asciidoctor/blob/main/README.adoc) for building the specifications if you don't want to install various dependencies. Note that the build artifacts belong to the `root` user.\n\n```bash\ndocker run --rm -it -v $(pwd):/documents asciidoctor/docker-asciidoctor\n# then run your build commands\n```\n\n## Tutorial Documents\n\n* [CLARIN Federated Content Search - FCS **Endpoint Developer's Tutorial**: `fcs-endpoint-dev-tutorial/index.adoc`](fcs-endpoint-dev-tutorial/index.adoc)\n\n  For build instructions, see section [Specification Documents \"How to build\"](#how-to-build).\n\n* [CLARIN Federated Content Search - FCS **Endpoint Development** Slides: `fcs-endpoint-dev-slides`](fcs-endpoint-dev-slides/index.adoc)\n\n  This is a RevealJS slide deck based on AsciiDoc and needs slightly different build steps. Those are currently only listed in the [GitHub Actions Workflow](.github/workflows/build-fcs-endpoint-dev-slides-adoc.yml). The following are a copy:\n\n  ```bash\n  # Output will be placed in `slides/`\n\n  # Setup \"dependencies\"\n  git clone -b 4.1.2 --depth 1 https://github.com/hakimel/reveal.js.git\n  mkdir -p slides/reveal.js\n  mv reveal.js/dist slides/reveal.js/\n  mv reveal.js/plugin slides/reveal.js/\n  rm -rf reveal.js/\n\n  git clone -b 10.7.3 --depth 1 https://github.com/highlightjs/highlight.js.git\n  mv highlight.js/src/styles/github.css slides/reveal.js/plugin/highlight/\n  mv highlight.js/src/styles/idea.css slides/reveal.js/plugin/highlight/\n  mv highlight.js/src/styles/magula.css slides/reveal.js/plugin/highlight/\n  rm -rf highlight.js/\n\n  # Build Slides\n  asciidoctor-revealjs -v -D slides fcs-endpoint-dev-slides/index.adoc\n\n  # Copy images/styles/...\n  cp -R -v fcs-endpoint-dev-slides/images slides/\n  cp -R -v fcs-endpoint-dev-slides/css slides/\n  cp -R -v fcs-endpoint-dev-slides/js slides/\n\n  # Display slides, visit \"localhost:8000\"\n  cd slides/\n  python3 -m http.server 8000\n  # or simply open the \"index.html\"\n  ```\n\n## Historical Resources\n\nTo be found under [`historical/`](historical/):\n\n- [`documents/`](historical/documents/) -- specification documents\n- [`examples/`](historical/examples/) -- examples from specification\n- [`schema/`](historical/schema/) -- `xsd` schema files\n- [`software/`](historical/software/)\n    - [`mpi-endpoint/`](historical/software/mpi-endpoint/) -- CQL Search servlet\n\n## Webpage with Builds\n\nA static overview webpage with _latest_ document builds is available at https://clarin-eric.github.io/fcs-misc/.\n\nTo update this page (only manually), go to [Actions: _publish to \\\u003cgh-pages\\\u003e_](https://github.com/clarin-eric/fcs-misc/actions/workflows/publish-gh-pages.yml) and trigger a rebuild with the _Run workflow_ button on the `main` branch.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclarin-eric%2Ffcs-misc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclarin-eric%2Ffcs-misc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclarin-eric%2Ffcs-misc/lists"}