org.texi: Document cross references
* doc/org.texi (Publishing links): Explain syntax for cross references.
This commit is contained in:
parent
1795d505e8
commit
0ff9a9a335
25
doc/org.texi
25
doc/org.texi
|
@ -14505,19 +14505,30 @@ however, override everything.
|
||||||
@cindex links, publishing
|
@cindex links, publishing
|
||||||
|
|
||||||
To create a link from one Org file to another, you would use something like
|
To create a link from one Org file to another, you would use something like
|
||||||
@samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
|
@samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org}
|
||||||
(@pxref{Hyperlinks}). When published, this link becomes a link to
|
(@pxref{External links}). When published, this link becomes a link to
|
||||||
@file{foo.html}. You can thus interlink the pages of your "org web" project
|
@file{foo.html}. You can thus interlink the pages of your ``org web''
|
||||||
and the links will work as expected when you publish them to HTML@. If you
|
project and the links will work as expected when you publish them to HTML.
|
||||||
also publish the Org source file and want to link to it, use an @code{http:}
|
If you also publish the Org source file and want to link to it, use an
|
||||||
link instead of a @code{file:} link, because @code{file:} links are converted
|
@code{http:} link instead of a @code{file:} link, because @code{file:} links
|
||||||
to link to the corresponding @file{html} file.
|
are converted to link to the corresponding @file{html} file.
|
||||||
|
|
||||||
You may also link to related files, such as images. Provided you are careful
|
You may also link to related files, such as images. Provided you are careful
|
||||||
with relative file names, and provided you have also configured Org to upload
|
with relative file names, and provided you have also configured Org to upload
|
||||||
the related files, these links will work too. See @ref{Complex example}, for
|
the related files, these links will work too. See @ref{Complex example}, for
|
||||||
an example of this usage.
|
an example of this usage.
|
||||||
|
|
||||||
|
Eventually, links between published documents can contain some search options
|
||||||
|
(@pxref{Search options}), which will be resolved to the appropriate location
|
||||||
|
in the linked file. For example, once published to HTML, the following links
|
||||||
|
all point to a dedicated anchor in @file{foo.html}.
|
||||||
|
|
||||||
|
@example
|
||||||
|
[[file:foo.org::*heading]]
|
||||||
|
[[file:foo.org::#custom-id]]
|
||||||
|
[[file:foo.org::target]]
|
||||||
|
@end example
|
||||||
|
|
||||||
@node Sitemap
|
@node Sitemap
|
||||||
@subsection Generating a sitemap
|
@subsection Generating a sitemap
|
||||||
@cindex sitemap, of published pages
|
@cindex sitemap, of published pages
|
||||||
|
|
Loading…
Reference in New Issue