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

"Delete" button docs #1007

Conversation

pljones
Copy link
Contributor

@pljones pljones commented Jul 29, 2024

Short description of changes

Adds a description for the new "Delete" button in the Connect and Advanced Settings dialogues.

Also expands and corrects some of the Connect dialogue description (in separate commits).

Context: Fixes an issue? Related issues
Fixes 1006

Status of this Pull Request
To be proof-read once the GitHub build runs.

What is missing until this pull request can be merged?
Review.

Does this need translation?
YES

Checklist

  • I've verified that this Pull Request follows the general code principles
  • I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
  • I'm sure that this Pull Request goes to the correct branch

@pljones pljones added this to the Release 3.11.0 milestone Jul 29, 2024
@pljones pljones force-pushed the issue-1002-delete-server-button-docs branch from 3c07fd0 to 5679eaf Compare July 29, 2024 19:01
@pljones
Copy link
Contributor Author

pljones commented Jul 29, 2024

Updated "Connect/disconnect button":


Connect/disconnect button

Opens a dialogue where you can select a server to connect to. If you are connected, pressing this button will end the session. You can also open the dialogue from File menu, Connection Setup. This will leave you connected to any current session until you join another.

Screenshot of the server connection window

The Connection Setup window shows a list of available Servers together with their "distance" (in terms of ping time), the number of occupants and the maximum number supported, and the Server's given location. Permanent Servers (those that have been listed for longer than 24 hours) are shown in bold.

Click on the Server you want to join and press the Connect button to connect to it. Alternatively, double-click on the server name.

Server operators register their servers with Directories. These are either genre-specific or for any genre, or additional custom entries. Use the Directory dropdown to select a genre. You can filter the list by server name or location. To list only occupied Servers, enter a "#" character. If you choose "Show All Musicians" the current occupants will be shown.

If you know the IP address or URL of a private Server, you can connect to it using the Server Name/Address field. An optional port number can be added after the address using a colon as a separator, e.g, jamulus.example.com:22124. (Note that IPv6 addresses must be entirely enclosed in square brackets.) The field will also show a list of the most recently used server addresses.
The button that follows the field allows the current entry to be removed from the list.


Updated "Custom Directories":


Custom Directories

If you need to add Directory addresses other than the built-in ones, you can do so here. If you know the IP address or host name of a custom Directory, you can connect to it using the Server Name/Address field. An optional port number can be added after the address using a colon as a separator, e.g, jamulus.example.com:22124. (Note that IPV6 is not currently supported for Directories.) The button that follows the field allows the current entry to be removed from the list.


@ann0see ann0see requested a review from gilgongo July 29, 2024 19:30
wiki/en/Software-Manual.md Outdated Show resolved Hide resolved
wiki/en/Software-Manual.md Outdated Show resolved Hide resolved
@pljones pljones force-pushed the issue-1002-delete-server-button-docs branch from 5679eaf to eaa807b Compare July 30, 2024 17:50
wiki/en/Software-Manual.md Outdated Show resolved Hide resolved
@pljones pljones force-pushed the issue-1002-delete-server-button-docs branch from eaa807b to cee15b2 Compare July 30, 2024 21:15
@pljones
Copy link
Contributor Author

pljones commented Jul 30, 2024

http://jamuluswebsite.drealm.info/wiki/Software-Manual
Hosted latest artifact

@pljones pljones linked an issue Jul 31, 2024 that may be closed by this pull request
@pljones
Copy link
Contributor Author

pljones commented Aug 1, 2024

In "My Profile", the example tooltip style omits the border:

<img src="https://user-images.githubusercontent.com/1549463/248553489-9ef871f6-32d1-4a2a-9f6f-29e23c40a629.png " style="border: 5px solid grey;" loading="lazy" alt="Image of a profile window">
<img src="https://user-images.githubusercontent.com/4561747/147836179-2eeb2935-2871-48aa-bf88-9b2622c7f5aa.png " style="width:30%;" loading="lazy" alt="Image of a tooltip showing profile information">

@gilgongo should it have the style added? Should I include that here?

@ann0see
Copy link
Member

ann0see commented Aug 1, 2024

Yes. I'd make it the same for everything

@pljones
Copy link
Contributor Author

pljones commented Aug 2, 2024

@ann0see,

Yes. I'd make it the same for everything

I guess we should really have a style defined for screenshots and use that consistently. I'll put it inline for now, though.

Any idea why it's got the width style others omit?

@ann0see
Copy link
Member

ann0see commented Aug 2, 2024

Yes. We should not have any css in HTML. But it was included a while ago with some changes to how screenshots work.

@ann0see
Copy link
Member

ann0see commented Aug 2, 2024

Any idea why it's got the width style others omit?

Probably just a hack. @gilgongo ?

@gilgongo
Copy link
Member

gilgongo commented Aug 2, 2024

Any idea why it's got the width style others omit?

Yes, just a hack as some screenshots with white edges looked odd on a white background while those with dark ones (eg full windows) didn't. So I added a local width to them - or something like that I recall.

@pljones
Copy link
Contributor Author

pljones commented Aug 2, 2024

OK, updated to add the border and drop the width:
http://jamuluswebsite.drealm.info/wiki/Software-Manual#my-profile

@ann0see
Copy link
Member

ann0see commented Aug 3, 2024

@gilgongo please check and if everything is okay merge it.

@pljones pljones self-assigned this Aug 4, 2024
@ann0see ann0see merged commit 919a163 into jamulussoftware:next-release Aug 4, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Update screenshots for "Delete Server" button
3 participants