wireviz / WireViz

Easily document cables and wiring harnesses.
GNU General Public License v3.0
4.33k stars 223 forks source link

[discussion] make position of pin numbers within connectors consistent? #404

Open formatc1702 opened 2 months ago

formatc1702 commented 2 months ago

Split of from https://github.com/wireviz/WireViz/issues/286#issuecomment-2225714107 , image taken from there

image

Currently, pin numbers appear on the left or the right of the connector's pin table depending on which side the wires come out.

This was implemented since the very first draft of WireViz and has remained unchanged. As more and more fields can/will be defined on a pin level (pin labels, color, notes, shorts/bridges, ...), it can cause confusion. And when daisy-chaining connectors horizontally, duplicating the pin number on both edges can look silly, especially if no other pin attributes are defined.

Should pin numbers always appear on the left, to keep the order of the columns consistent across all connectors? Personally, I am leaning more and more in favor of this solution.

AlanLivingston commented 2 months ago

I use these wireviz drawings to document cabling and to assist technicians with construction cables. Our techs like the pin numbers next to the wires, as that's the information they use most when making the cable. Many times, they don't care about or refer to the signal name. I'd prefer to move the signal names into the rightmost column after the shorts, so that it's a mirror image of the left connector.

martinrieder commented 2 months ago

Some thought that I have been considering to post as a feature request recently: Currently, pin activation takes effect on both sides of the connector, causing the entire pin list to be shown on whichever side there is any connection. Should it also be possible to show individual pin listings on the left and right side of connectors? Or would it just overcomplicate things?

formatc1702 commented 2 months ago

Our techs like the pin numbers next to the wires, as that's the information they use most when making the cable.

That was the thinking behind the initial behavior :)

martinrieder commented 2 months ago

I wrote https://github.com/wireviz/WireViz/issues/404#issuecomment-2225983880 under the assumption that hide_disconnected_pins is active. IMO this should treat both sides independently to produce a more compact output. Any opinions on this?

tobiasfalk commented 2 months ago

First, I would not talk about left and right but rather see it like an onion, with a core, outside, and inside (currently empty) layers. Currently, the outside layer is always th Nr. and then the core goes lable and jumpers

Second, I think that this outside and inside layers are mirrored if wiers are connected to both sides of the connector.

It would be reasonable to put the lable into the first inside layer.

It would also be good if it would be selectable if these layers are always left, right, both sides or auto(similar to current).

It would also be reasonable if it would be possible to select if the lable is part of the core or layer.

I think that things like the jumpers should remain in the core.

kvid commented 2 weeks ago

@martinrieder wrote:

I wrote #404 (comment) under the assumption that hide_disconnected_pins is active. IMO this should treat both sides independently to produce a more compact output. Any opinions on this?