Table cross reference examples

[taqtiqa-mark]

Hi, Asciidoctor is a powerful and expressive tool. Many thanks for all the work that has gone into it.

I've found it remarkably difficult to find any example of cross referencing a table.

Example context 1: "Table 4 lists all the ways you can refer to a table"

Example context 1: "For further examples of all the ways you can refer to a table, please see Table 4. Table cross reference styles"

Naturally the cross references would be hyper-linked.

Appreciate any pointers to the tips, tricks or incantations to achieve this.

[marcekowalski]

See example below. Just standard anchoring.

The receiver model has eleven model specific parameters. Two of these parameters control the linear equalization, six parameters control the non-linear equalization (DFE), two parameters control the adaptation mode, and one parameter sets the process corner. <> lists these model parameters with their maximum, minimum, default values. The default parameter values set the receiver to minimum equalization, and turn the adaptation off.

.Receiver Model Parameters [[rxmodelpara]] |===

|No |Parameter |Description |Type |Min |Max |Default

|1 |rx_agc_lf |Low-frequency AGC |Int |0 |7 |7 |===

[mojavelinux]

Thanks for the follow-up @marcekowalski!

Is there an action here for changing the user manual or is this now clear?

[taqtiqa-mark]

I think that would be clear if I'd internalized asciidoctors code base ;) I haven't. So I have to say:

• For a user manual the above would do more harm than good.
• For a developer manual some references to further documenttaion of the receiver model, etc wouldn't hurt. That said, a well written behavior suite and unit tests are better than docs, even linking to the relevant cucumber files and rspec files would constitute developer documentation.

[jaredmorgs]

Perhaps if we link to the http://asciidoctor.org/docs/user-manual/#xref section in the tables introduction, it might act as a memory jogger for those who are jumping to this section in the guide for the first time.

(Tables are, by far, the hardest part of Asciidoctor and I'd suggest they might be up there in page hit ranks.).

[mojavelinux]

I think this issue is actually orthogonal to tables. The same need arises to link to any block, whether it is a table or not. In each section that covers a block type, we might want some standard text that says:

"you can reference this type of block from other parts of the document using cross references. See xrefs."

[jaredmorgs]

yep, I agree with this approach.

On Wed, 27 Jan 2016 at 13:27 Dan Allen [email protected] wrote:

I think this issue is actually orthogonal to tables. The same need arises to link to any block, whether it is a table or not. In each section that covers a block type, we might want some standard text that says:

"you can reference this type of block from other parts of the document using cross references. See xrefs."

— Reply to this email directly or view it on GitHub https://github.com/asciidoctor/asciidoctor.org/issues/342#issuecomment-175370092 .

Sent from Mobile.

[ernest-bruce]

Hi, Asciidoctor is a powerful and expressive tool. Many thanks for all the work that has gone into it.

I've found it remarkably difficult to find any example of cross referencing a table.

Example context 1: "Table 4 lists all the ways you can refer to a table"

Example context 1: "For further examples of all the ways you can refer to a table, please see Table 4. Table cross reference styles"

Naturally the cross references would be hyper-linked.

Appreciate any pointers to the tips, tricks or incantations to achieve this.

See example below. Just standard anchoring.

The receiver model has eleven model specific parameters. Two of these parameters control the linear equalization, six parameters control the non-linear equalization (DFE), two parameters control the adaptation mode, and one parameter sets the process corner. <> lists these model parameters with their maximum, minimum, default values. The default parameter values set the receiver to minimum equalization, and turn the adaptation off.

.Receiver Model Parameters [[rxmodelpara]] |===

|No |Parameter |Description |Type |Min |Max |Default

|1 |rx_agc_lf |Low-frequency AGC |Int |0 |7 |7 |===

how do i make a table xref leveraging the autogenerated table number?

creating an anchor does not address my issue . i want the generated link to read something like “Table 1 shows ...” (the tags would not appear in the text)

[taqtiqa-mark]

I think this issue is actually orthogonal to tables. The same need arises to link to any block, whether it is a table or not. In each section that covers a block type, we might want some standard text that says:

"you can reference this type of block from other parts of the document using cross references. See xrefs."

I think a simple example always wins, maybe examples go at the end of the section. So the standard text says:

"you can reference this type of block from other parts of the document using cross references. See the example at the end of this section, and xrefs for additional details."

I should confess I don't use asciidoctor that much so I may not be the target audience.

[mojavelinux]

Please direct questions to the project chat at https://chat.asciidoctor.org as stated on the support policy page. Thanks.