Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

eventID and synonym documentation #2837

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions app/routes/circulars._archive._index/route.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ export default function () {
const [inputQuery, setInputQuery] = useState(query)
const viewState = isGroupView ? 'Index' : 'Group'
const clean = inputQuery === query
const searchText = isGroupView ? 'Event Name' : 'Search'

return (
<>
Expand Down Expand Up @@ -267,8 +268,8 @@ export default function () {
id="query"
name="query"
type="search"
placeholder={searchText}
defaultValue={inputQuery}
placeholder="Search"
aria-describedby="searchHint"
onChange={({ target: { form, value } }) => {
setInputQuery(value)
Expand Down Expand Up @@ -314,12 +315,20 @@ export default function () {
</Button>
</Link>
</ToolbarButtonGroup>
<Hint id="searchHint">
Search for Circulars by submitter, subject, or body text (e.g. 'Fermi
GRB'). <br />
To navigate to a specific circular, enter the associated Circular ID
(e.g. 'gcn123', 'Circular 123', or '123').
</Hint>
{!isGroupView && (
<Hint id="searchHint">
Search for Circulars by submitter, subject, or body text (e.g. 'Fermi
GRB'). <br />
To navigate to a specific circular, enter the associated Circular ID
(e.g. 'gcn123', 'Circular 123', or '123').
</Hint>
)}
{isGroupView && (
<Hint id="searchHint">
Search for Event Groups by eventID (e.g. 'GRB 123456A', 'GRB123456A',
'123456A'). <br />
</Hint>
)}
{useFeature('CIRCULARS_LUCENE') && <LuceneAccordion />}
{clean && (
<>
Expand Down
27 changes: 27 additions & 0 deletions app/routes/docs.circulars.archive.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ handle:

import { Link } from '@remix-run/react'

import { WithFeature } from '~/root'

# Circulars Archive

Upon successful submission and distribution, a GCN Circular is assigned a number and stored permanently in the [GCN Circulars archive](/circulars). The archive lists links to the full text of every GCN Circular in reverse chronological order. The archive has a full-text search feature that you can use to find all Circulars that contain a phrase or keyword.
Expand All @@ -19,6 +21,31 @@ You can search the Circulars Archive by keywords or phrases in the subject, body

You can also filter search results by submission date. Select the dropdown button labeled "Filter by date". From there, you can either select from a number of predefined time ranges (e.g., "Last Hour", "Last Day", etc.) or specify a custom date range, which can either be set as a start date, an end date, or both. All search filters can be cleared by clicking the 'x' button in the search bar.

You can also type in a specific Circular ID (e.g. 12345) and it will list that Circular. Note that GRB names without a letter can be interpreted as Circular IDs.

<WithFeature SYNONYMS>
## Event View

The Circulars archive provides an Event View that allows users to view all Circulars associated with a particular astronomical event. This is enabled by the eventID and Synonym Groups features.

Each Circular is automatically assigned an `eventID` derived from the `Subject` field (e.g. GRB 250109A, EP250109a). This assignment is done by matching against a regular expressions list.

The `eventID` is listed in the JSON format version of Circulars. The first eventID used in the subject is associated automatically, and all Circulars with the same eventID are in a Synonym Group. GCN moderators can associate multiple eventIDs to Synonym Groups, such that all Circulars with these eventIDs will be listed in the same group.

### Adding events to the same synonym group

GCN Team moderators can create or modify synonym groups. If you would like to suggest the creation or modification of a synonym group, submit a ticket via [the contact form](/support).

### Searching by eventID

In the Event View search bar, enter in an eventID and it will take you to the associated Synonym Group. It will recognize regular expressions associated with the `eventID` (e.g. GRB 123456A, GRB123456A, 123456A).

### Linking to an eventID or Synonym Group

To save a direct link to all Circulars assocaited with a particular `eventID` or Synonym Group, you can point to any `eventID` in that group, e.g. `https://gcn.nasa.gov/circulars/group/[eventID]'.

</WithFeature>

## Citing GCN Circulars

The [SAO/NASA Astrophysics Data System (ADS)](https://ui.adsabs.harvard.edu) ingests and indexes all GCN Circulars. You can use ADS to get bibliographic records for GCN Circulars to cite them in a publication.
Expand Down
2 changes: 1 addition & 1 deletion app/routes/docs.circulars.corrections/route.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import versionbuttonscreenshot from './version_button.png'

# Corrections

Circulars authors can request changes to archived Circulars to correct inaccurate information, especially when the correction is important for the follow-up community's activities. These may include author lists, subject corrections, typos, and incorrect citations. Do not use the corrections feature to add details of new observations or analyses. In such cases, submit a new Circular with an appropriate subject (e.g. "refined analysis" or "additional observations").
Circulars authors can request changes to archived Circulars to correct inaccurate information, especially when the correction is important for the follow-up community's activities. These may include author lists, subject corrections, eventID additions or corrections, typos, and incorrect citations. Do not use the corrections feature to add details of new observations or analyses. In such cases, submit a new Circular with an appropriate subject (e.g. "refined analysis" or "additional observations").

## Who can request corrections?

Expand Down