Basic update for new GitBook structuring standards
This commit is contained in:
Родитель
0981bdb7f1
Коммит
321fb4b01f
|
@ -0,0 +1,5 @@
|
|||
root: ./
|
||||
|
||||
structure:
|
||||
readme: index.md
|
||||
summary: SUMMARY.md
|
44
README.md
44
README.md
|
@ -1,5 +1,43 @@
|
|||
# WorldWide Telescope Data Files Reference
|
||||
# WWT Data Files Reference: Source Code
|
||||
|
||||
This document describes the data file formats used by the WorldWide Telescope. The files are XML files, and have the extension .WTML. Also covered are a few URL based controls that enable the sharing of single images without creating data files.
|
||||
This repository contains the source code for the
|
||||
[AAS WorldWide Telescope Data Files Reference] documentation. The `master`
|
||||
branch of this repo is rendered by [GitBook] to appear here:
|
||||
|
||||
Data files are used to add to the default data and user experience of WorldWide Telescope. Data files are used to add single or multiple images -- either foreground images (typically single images referred to as _studies_) or background images (typically created from a large number of images, covering all or most of the sky, and referred to as _surveys_), to add tours (animated slide-shows), to create sign up files for communities (public or private groups that can share data), and to add simple or complex sets of data and links for those communities.
|
||||
### https://worldwidetelescope.gitbook.io/data-files-reference/
|
||||
|
||||
If you’re just interested in the documentation itself, you should go to that
|
||||
website. If you’re interested in *contributing* to this documentation, you’ve
|
||||
come to the right place! If you’re new to the project, please see the
|
||||
[WWT Contributors’ Guide] and the [WWT Code of Conduct]. We operate with a
|
||||
standard [fork-and-pull] model.
|
||||
|
||||
[AAS WorldWide Telescope Data Files Reference]: https://worldwidetelescope.gitbook.io/data-files-reference/
|
||||
[WWT Contributors’ Guide]: https://worldwidetelescope.github.io/contributing/
|
||||
[WWT Code of Conduct]: https://worldwidetelescope.github.io/code-of-conduct/
|
||||
[fork-and-pull]: https://help.github.com/en/articles/about-collaborative-development-models
|
||||
|
||||
The files in this repository follow the structure described in the
|
||||
[WWT GitBook Markdown documentation specification]. The content is
|
||||
fundamentally in [Markdown] format, but there are special patterns and extra
|
||||
features used by [GitBook].
|
||||
|
||||
[GitBook]: https://docs.gitbook.com/
|
||||
[WWT GitBook Markdown documentation specification]: https://worldwidetelescope.gitbook.io/miscellaneous/documents/gitbook-spec
|
||||
[Markdown]: https://commonmark.org/
|
||||
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
The AAS WorldWide Telescope system is a [.NET Foundation] project managed by
|
||||
the non-profit [American Astronomical Society] (AAS). Work on WWT has been
|
||||
supported by the AAS, the US [National Science Foundation] (grants [1550701]
|
||||
and [1642446]), the [Gordon and Betty Moore Foundation], and [Microsoft].
|
||||
|
||||
[.NET Foundation]: https://dotnetfoundation.org/
|
||||
[American Astronomical Society]: https://aas.org/
|
||||
[National Science Foundation]: https://www.nsf.gov/
|
||||
[1550701]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=1550701
|
||||
[1642446]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=1642446
|
||||
[Gordon and Betty Moore Foundation]: https://www.moore.org/
|
||||
[Microsoft]: https://www.microsoft.com/
|
||||
|
|
15
SUMMARY.md
15
SUMMARY.md
|
@ -1,18 +1,5 @@
|
|||
# Summary
|
||||
|
||||
* [Collections Files](collections.md)
|
||||
* [Structure of a Collection File](collections.md#structure-of-a-collection-file)
|
||||
* [Places](collections.md#places)
|
||||
* [Studies](collections.md#studies)
|
||||
* [Surveys](collections.md#surveys)
|
||||
* [Tours](collections.md#tours)
|
||||
* [Communities](collections.md#communities)
|
||||
* [Including Other WTML Files](collections.md#including-other-wtml-files)
|
||||
* [WTML Samples](collections.md#wtml-samples)
|
||||
* [Sharing Views](sharingviews.md)
|
||||
* [Goto](sharingviews.md#goto)
|
||||
* [ShowImage](sharingviews.md#show-image)
|
||||
* [Command Line](sharingviews.md#command-line)
|
||||
* [Appendices](appendices.md)
|
||||
* [Classifications](appendices.md#classifications)
|
||||
* [Constellations](appendices.md#constellations)
|
||||
* [Taxonomy](appendices.md#taxonomy)
|
||||
|
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
description: Reference documentation for various WWT data files.
|
||||
---
|
||||
|
||||
This document describes the data file formats used by the WorldWide Telescope. The files are XML files, and have the extension .WTML. Also covered are a few URL based controls that enable the sharing of single images without creating data files.
|
||||
|
||||
Data files are used to add to the default data and user experience of WorldWide Telescope. Data files are used to add single or multiple images -- either foreground images (typically single images referred to as _studies_) or background images (typically created from a large number of images, covering all or most of the sky, and referred to as _surveys_), to add tours (animated slide-shows), to create sign up files for communities (public or private groups that can share data), and to add simple or complex sets of data and links for those communities.
|
Загрузка…
Ссылка в новой задаче