Wiki

Clone wiki

rst_link_test / Home

summary

This file is our project's wiki's rootpage, which Bitbucket requires to be named Home. It exists solely to see how/if we can link to/from it to other project resources. For terms used below, see section= definitions in this project's README.

ordinary file in project repo

We want to be able to link to ordinary files in the "main" project repo, , i.e., objects which are not in its

  • downloads
  • issues

project-absolute style

  1. a file in the project's top-level folder: /file_in_project_root.txt
  2. a file in a child of the project's top-level folder: /subdir_level_1/file_in_folder_just_below_project_root.rst

relative style

  1. a file in the project's top-level folder: ../file_in_project_root.txt
  2. a file in a child of the project's top-level folder: ../subdir_level_1/file_in_folder_just_below_project_root.rst

currently-working style

Gotta add src and branch, e.g.,

  1. a file in the project's top-level folder: ../src/HEAD/file_in_project_root.txt
  2. a file in a child of the project's top-level folder: ../src/HEAD/subdir_level_1/file_in_folder_just_below_project_root.rst

Bitbucket style

These may work from Bitbucket project READMEs viewed from page=Overview (dunno about from the wiki):

  1. a file in the project's top-level folder: rst_link_test/file_in_project_root.txt
  2. a file in a child of the project's top-level folder: rst_link_test/subdir_level_1/file_in_folder_just_below_project_root.rst

downloads

We've got downloads! How to reference them?

project-absolute style

  1. page listing current downloads: /downloads
  2. a specific download: /downloads/downloadable_1.txt

currently-working style

Issues are project resources (not in the filetree). Nevertheless, empirically, currently:

  1. page listing current downloads: ../downloads
  2. a specific download: ../downloads/downloadable_1.txt

Bitbucket style

  1. page listing current downloads: rst_link_test/downloads
  2. a specific download: rst_link_test/downloads/downloadable_1.txt

issues

We've got issues! How to reference them?

project-absolute style

  1. page listing current issues: /issues
  2. page for creating new issue: /issues/new
  3. page for specific issue#=1: /issue/1

currently-working style

Issues are project resources (not in the filetree). Nevertheless, empirically, currently:

  1. page listing current issues: ../issues
  2. page for creating new issues: ../issues/new
  3. page for issue#=1: ../issue/1

Bitbucket style

  1. page listing current issues: rst_link_test/issues
  2. page for creating new issue: rst_link_test/issues/new
  3. page for specific issue#=1: rst_link_test/issue/1

wiki pages

How to reference other wikipages? E.g., another wikipage, but in a folder/subdir 1 level down:

relative style

  1. same folder/subdir:

    1. path beginning with dot:
      1. with extension: ./another_wikipage_in_top-level_folder.rst
      2. without extension: ./another_wikipage_in_top-level_folder
    1. path=filename:
      1. with extension: another_wikipage_in_top-level_folder.rst
      2. without extension: another_wikipage_in_top-level_folder
  2. one level down:

    1. with extension: ./subdir_level_2/wikipage_in_child_folder.rst
    2. without extension: ./subdir_level_2/wikipage_in_child_folder

an image

in downloads

project-absolute style

  • /downloads/Jen_Sorensen_PandP-poster-ForWeb.png:
alternate text

If you see alternate text or a broken link instead of an image, the path attempt failed.

currently-working style

  • ../downloads/Jen_Sorensen_PandP-poster-ForWeb.png:
alternate text

If you see alternate text or a broken link instead of an image, the path attempt failed.

Bitbucket style

  • rst_link_test/downloads/Jen_Sorensen_PandP-poster-ForWeb.png:
alternate text

If you see alternate text or a broken link instead of an image, the path attempt failed.

in project repo

project-absolute style

  • /images/Jen_Sorensen_PandP-poster-ForWeb.png:
alternate text

If you see alternate text or a broken link instead of an image, the path attempt failed.

relative style

  • ../images/Jen_Sorensen_PandP-poster-ForWeb.png:
alternate text

If you see alternate text or a broken link instead of an image, the path attempt failed.

why won't this work?

Note that

  1. This works: ../src/HEAD/subdir_level_1/file_in_folder_just_below_project_root.rst
  2. In the main project's sources== ../src , ./images and ./subdir_level_1 are peers
  3. ... but this fails: ../src/HEAD/images/Jen_Sorensen_PandP-poster-ForWeb.png

Why???

  • ../src/HEAD/images/Jen_Sorensen_PandP-poster-ForWeb.png
alternate text

If you see alternate text or a broken link instead of an image, the path attempt failed.

Bitbucket style

  • rst_link_test/images/Jen_Sorensen_PandP-poster-ForWeb.png:
alternate text

If you see alternate text or a broken link instead of an image, the path attempt failed.

Updated