Skip to content

Breadcrumb #306

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.

Sign up for GitHub

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

Merged
gilgongo merged 13 commits into from
Feb 16, 2021
Merged

Breadcrumb #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8f1ecd3
Add breadcrumb style
gilgongo Feb 16, 2021
be73bf4
Create breadcrumb.html
gilgongo Feb 16, 2021
fb11a81
Update breadcrumb.html
gilgongo Feb 16, 2021
780f692
Update en-Central-Servers.md
gilgongo Feb 16, 2021
c573a94
Update en-Choosing-a-Server-Type.md
gilgongo Feb 16, 2021
78e2bfb
Update en-Installation-for-Windows.md
gilgongo Feb 16, 2021
4e15dae
Update en-Installation-for-Macintosh.md
gilgongo Feb 16, 2021
be76181
Update en-Installation-for-Linux.md
gilgongo Feb 16, 2021
689c791
Update en-Hardware-Setup.md
gilgongo Feb 16, 2021
228669c
Update en-Running-a-Private-Server.md
gilgongo Feb 16, 2021
a1a3773
Update en-Server-Linux.md
gilgongo Feb 16, 2021
8368348
Update en-Server-Troubleshooting.md
gilgongo Feb 16, 2021
fe28ed0
Update en-Server-Win-Mac.md
gilgongo Feb 16, 2021
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
14 changes: 14 additions & 0 deletions _includes/breadcrumb.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<div id="breadcrumb">
{% if include.root %}
<strong>{{ include.root }}</strong> |
{% endif %}
{% if include.branch1 %}
Copy link
Copy Markdown
Member

@ann0see ann0see Feb 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea! Do you think a loop would be better here so more than two items can be created?

Copy link
Copy Markdown
Member Author

@gilgongo gilgongo Feb 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how to create a loop, but I guess if we ever wanted to get more than three levels deep we could just change the include to accept that (or just a "branch3"....)

Copy link
Copy Markdown
Member

@ann0see ann0see Feb 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I think, we should include three levels now. It's better to have too many than not enough ;-).

Copy link
Copy Markdown
Member Author

@gilgongo gilgongo Feb 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK I'll add a third (BTW just been reading about loops but I'm not sure how to get the alternating linktext/link thing working with that).

I'll put them on the page then and add to this branch. Would be good to get that in before translation starts.

Copy link
Copy Markdown
Member

@ann0see ann0see Feb 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ll put them on the page then and add to this branch. Would be good to get that in before translation starts.

Agree.

Same for the linux installation guide.

Copy link
Copy Markdown
Member Author

@gilgongo gilgongo Feb 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK I've done that now I think. Note that it's quite a "conservative" breadcrumb because it's not on every page, just the one's that are sort of "children" of others.

Copy link
Copy Markdown
Member

@ann0see ann0see Feb 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! I've also edited the Linux install pages (client/server). But I think they will soon need to be re-written because they look quite messy...

<a href="{{ include.branch1-url }}">{{ include.branch1 }}</a>
{% endif %}
{% if include.branch2 %}
&gt; <a href="{{ include.branch2-url }}">{{ include.branch2 }}</a>
{% endif %}
{% if include.branch3 %}
&gt; <a href="{{ include.branch3-url }}">{{ include.branch3 }}</a>
{% endif %}
</div>
5 changes: 5 additions & 0 deletions assets/css/wiki.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@
padding: 20px;
}

.wikisite #breadcrumb {
line-height: 90%;
font-size: 0.90em;
}

.wikisite .button-container {
margin: .25em 0;
}
Expand Down
2 changes: 2 additions & 0 deletions wiki/en/en-Central-Servers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ lang: "en"
permalink: "/wiki/Central-Servers"
---

{% include breadcrumb.html root="More" branch1="Running a Server" branch1-url="Running-a-Server" %}

# Public Server Registration

Because there is a limit of 150 servers per central server, you need to select which central server you want to advertise your server on. Select a genre if you intend to limit players to that style (players can then see your server in their genre list).
Expand Down
2 changes: 2 additions & 0 deletions wiki/en/en-Choosing-a-Server-Type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ lang: "en"
permalink: "/wiki/Choosing-a-Server-Type"
---

{% include breadcrumb.html root="More" branch1="Running a Server" branch1-url="Running-a-Server" %}

# Server Types

You can run your server in one of three "modes" (either at home or on a 3rd party host):
Expand Down
2 changes: 2 additions & 0 deletions wiki/en/en-Hardware-Setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ lang: "en"
permalink: "/wiki/Hardware-Setup"
---

{% include breadcrumb.html root="Using Jamulus" branch1="Getting Started" branch1-url="Getting-Started" %}

# Hardware Setup

## General info
Expand Down
2 changes: 2 additions & 0 deletions wiki/en/en-Installation-for-Linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ lang: "en"
permalink: "/wiki/Installation-for-Linux"
---

{% include breadcrumb.html root="Using Jamulus" branch1="Getting Started" branch1-url="Getting-Started" %}

# Installation for Linux
Make sure you read the [Getting Started](Getting-Started) page.

Expand Down
2 changes: 2 additions & 0 deletions wiki/en/en-Installation-for-Macintosh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ lang: "en"
permalink: "/wiki/Installation-for-Macintosh"
---

{% include breadcrumb.html root="Using Jamulus" branch1="Getting Started" branch1-url="Getting-Started" %}

# Installation for macOS

Make sure you've already read the [Getting Started](Getting-Started) page.
Expand Down
2 changes: 2 additions & 0 deletions wiki/en/en-Installation-for-Windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ lang: "en"
permalink: "/wiki/Installation-for-Windows"
---

{% include breadcrumb.html root="Using Jamulus" branch1="Getting Started" branch1-url="Getting-Started" %}

# Installation for Windows
Make sure you read the [Getting Started](Getting-Started) page.
1. **Download and install an ASIO Driver**. It is recommended to use a sound card/interface with a native ASIO driver. If you don't have an external sound card, you probably need to install [this free ASIO driver (ASIO4ALL)](https://www.asio4all.org){: target="_blank" rel="noopener noreferrer"} before installing Jamulus.
Expand Down
2 changes: 2 additions & 0 deletions wiki/en/en-Running-a-Private-Server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ lang: "en"
permalink: "/wiki/Running-a-Private-Server"
---

{% include breadcrumb.html root="Using Jamulus" branch1="Running a Server" branch1-url="Running-a-Server" %}

# Running a Private Server

**_Please ensure you have read the [server overview](Running-a-Server)_**
Expand Down
2 changes: 2 additions & 0 deletions wiki/en/en-Server-Linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ lang: "en"
permalink: "/wiki/Server-Linux"
---

{% include breadcrumb.html root="Using Jamulus" branch1="Running a Server" branch1-url="Running-a-Server" %}

# Server Installation - Linux


Expand Down
2 changes: 2 additions & 0 deletions wiki/en/en-Server-Troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ lang: "en"
permalink: "/wiki/Server-Troubleshooting"
---

{% include breadcrumb.html root="Using Jamulus" branch1="Running a Server" branch1-url="Running-a-Server" %}

# Troubleshooting

## Servers - Public
Expand Down
2 changes: 2 additions & 0 deletions wiki/en/en-Server-Win-Mac.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ lang: "en"
permalink: "/wiki/Server-Win-Mac"
---

{% include breadcrumb.html root="Using Jamulus" branch1="Running a Server" branch1-url="Running-a-Server" %}

# Installation for Windows and macOS


Expand Down