Skip to content

update link to sections info #768

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
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
32 changes: 22 additions & 10 deletions content/docs-v1/page-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,28 +106,40 @@ This linking can be applied to a piece of text that when clicked upon will take
[fig. 1](#1.1)
```

#### Links to Other Page Elements
### Internal Links to Specific Elements on Pages

There are several types of linking between features, text, or objects on a single page that can be included through the following Markdown formatting:

#### Links to Figures

This linking can be applied to a piece of text that when clicked upon will take a user to the location of the corresponding figure on the page. Figure IDs can be found on the `figures.yml` page as explained in the [*Figure Images*](/docs-v0/figure-images/) chapter of this guide. They are proceeded by the # symbol when used as a link address.

An ID and the # symbol is also used for other kinds of elements on the same page. The IDs for these elements can be found using the following method:
```md
[number or name of figure](#figureid)
[fig. 1](#1.1)
```

- Use the Inspect Element tool when right clicking a page or specific element. For Safari users, refer to this [guide](https://apple.stackexchange.com/questions/139767/inspect-element-in-safari) to enable this feature.
#### Links to Specific Section on a Page

- In the page's code, certain elements will include a piece of code, `id="idnamehere"` that designates the ID of that element. If the name of the element has a space that will be represented with a dash `-`.
You can also link to specific sections on a page by creating an ID and associating it with that section's header. Then you can reference the assigned ID in the text you want to be linked.

- For example, the ID of a heading will often be the name of that heading.
```md
{#assigned-header-id}
[header name](#assigned-header-id)
```

```md
[referencetolink](#element-id)
See [heading 1](#heading-1).
## Scientific Methodology {#scientific-methodology}
See [Scientific Methodology](#scientific-methodology) for more information
```

#### Links to Elements on a Separate Page
#### Links to Specific Section on Other Pages

Following the formula for internal links between pages, you can also specify an element on a separate page as a link destination by adding the # symbol and the element’s ID on to the end of a page link.
You can also link to this header from a separate page.

```md
[referencetolink](/nameofpage/#idname)
See the introduction [notes](/introduction/#notes)
See the [Scientic Methodology](/paper-4/#scientific-methodology) in paper 4
```

#### Linked Footnotes
Expand Down