From 06f5267582584cecd91d74a534fca9bc03082920 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sat, 31 Dec 2022 17:11:04 +0100 Subject: [PATCH] Use named links in Markdown instead of numbered ones This is more clear and avoids problems with mis-numbering. Closes #23090. --- docs/doxygen/overviews/high_dpi.md | 31 +++++++++++++++--------------- docs/doxygen/overviews/install.md | 28 +++++++++++++-------------- 2 files changed, 30 insertions(+), 29 deletions(-) diff --git a/docs/doxygen/overviews/high_dpi.md b/docs/doxygen/overviews/high_dpi.md index 58960a1a09..e08fa98d58 100644 --- a/docs/doxygen/overviews/high_dpi.md +++ b/docs/doxygen/overviews/high_dpi.md @@ -194,9 +194,9 @@ consideration also the quality might suffer, contours become more blurry, so for best results it is recommended to use the images that can be used without scaling at the common DPI values, i.e. at least 100% and 200% scaling. If you don't want providing several copies of all bitmaps, you can use a single -vector image in [SVG format][1] instead. +vector image in [SVG format][] instead. -[1]: https://en.wikipedia.org/wiki/Scalable_Vector_Graphics +[SVG format]: https://en.wikipedia.org/wiki/Scalable_Vector_Graphics In either case, you must use wxBitmapBundle class representing several different versions of the same bitmap (or even potentially just a single one, @@ -270,11 +270,11 @@ bitmap will be the default bundle size, which must be provided when creating this kind of bitmap bundle, as SVG image itself doesn't necessarily contain this information. -Note that wxWidgets currently uses [NanoSVG][1] library for SVG support and so +Note that wxWidgets currently uses [NanoSVG][] library for SVG support and so doesn't support all SVG standard features and you may need to simplify or tweak the SVG files to make them appear correctly. -[1]: https://github.com/memononen/nanosvg +[NanoSVG]: https://github.com/memononen/nanosvg wxBitmapBundle and XRC {#high_dpi_bundle_xrc} ---------------------- @@ -317,22 +317,23 @@ MSW {#high_dpi_platform_msw} --- The behaviour of the application when running on a high-DPI display depends on -the values in its [manifest][1]. You may either use your own manifest, in which -case you need to define the `dpiAware` (for compatibility with older OS -versions) and `dpiAwareness` (for proper per-monitor DPI support) in it, or -simply include `wx/msw/wx.rc` from your resource file to use the manifest -provided by wxWidgets and predefine `wxUSE_DPI_AWARE_MANIFEST` to opt-in into -[high DPI support][2]: define it as `1` for minimal DPI awareness and `2` for -full, per-monitor DPI awareness supported by Windows 10 version 1703 or later. +the values in its [manifest][msw-manifest]. You may either use your own +manifest, in which case you need to define the `dpiAware` (for compatibility +with older OS versions) and `dpiAwareness` (for proper per-monitor DPI support) +in it, or simply include `wx/msw/wx.rc` from your resource file to use the +manifest provided by wxWidgets and predefine `wxUSE_DPI_AWARE_MANIFEST` to +opt-in into [high DPI support][msw-highdpi]: define it as `1` for minimal DPI +awareness and `2` for full, per-monitor DPI awareness supported by Windows 10 +version 1703 or later. -[1]: https://docs.microsoft.com/en-us/windows/win32/sbscs/application-manifests -[2]: https://docs.microsoft.com/en-us/windows/win32/hidpi/high-dpi-desktop-application-development-on-windows +[msw-manifest]: https://docs.microsoft.com/en-us/windows/win32/sbscs/application-manifests +[msw-highdpi]: https://docs.microsoft.com/en-us/windows/win32/hidpi/high-dpi-desktop-application-development-on-windows macOS {#high_dpi_platform_mac} ----- DPI-aware applications must set their `NSPrincipalClass` to `wxNSApplication` (or at least `NSApplication`) in their `Info.plist` file. Also see Apple [high -resolution guidelines][3] for more information. +resolution guidelines][apple-highdpi] for more information. -[3]: https://developer.apple.com/library/archive/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Explained/Explained.html +[apple-highdpi]: https://developer.apple.com/library/archive/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Explained/Explained.html diff --git a/docs/doxygen/overviews/install.md b/docs/doxygen/overviews/install.md index f059d212bd..f5afe05bc5 100644 --- a/docs/doxygen/overviews/install.md +++ b/docs/doxygen/overviews/install.md @@ -20,7 +20,7 @@ Using Binaries How to install binaries depends on your platform: - For Microsoft Windows (MSW), wxWidgets project provides official binaries - on the [Downloads page](http://www.wxwidgets.org/downloads/), please see + on the [Downloads page][], please see the [instructions for using them](@ref plat_msw_binaries). - For Linux, and other free Unix-like systems, wxWidgets packages are available @@ -31,18 +31,19 @@ How to install binaries depends on your platform: Ubuntu, you need to run `apt get libwxgtkX.Y-dev`. - For macOS, wxWidgets is available in third-party package managers such as - [brew][1] or [MacPorts][2], and you can install them in the usual way. + [brew][] or [MacPorts][], and you can install them in the usual way. -[1]: https://brew.sh/ -[2]: https://www.macports.org/ +[downloads page]: https://www.wxwidgets.org/downloads/ +[brew]: https://brew.sh/ +[MacPorts]: https://www.macports.org/ Additionally, some third-party C++ package managers also provide wxWidgets -binaries. For example, please see [this post][3] for the instructions about -using [vcpkg][4] C++ package manager for installing wxWidgets. +binaries. For example, please see [this post][vcpkg-post] for the instructions +about using [vcpkg][] C++ package manager for installing wxWidgets. -[3]: https://www.wxwidgets.org/blog/2019/01/wxwidgets-and-vcpkg/ -[4]: https://github.com/microsoft/vcpkg +[vcpkg-post]: https://www.wxwidgets.org/blog/2019/01/wxwidgets-and-vcpkg/ +[vcpkg]: https://github.com/microsoft/vcpkg Building from Source @@ -56,7 +57,7 @@ using the following command: $ git clone --recurse-submodules https://github.com/wxWidgets/wxWidgets.git -Alternatively, you can download the sources from the [downloads page][1]. +Alternatively, you can download the sources from the [downloads page][]. Please note that all the source archives in different formats (ZIP, 7z, tar.bz2) contain the same files, but use different line ending formats: Unix ("LF") for the latter one and DOS ("CR LF") for the two other ones, and it is @@ -64,7 +65,6 @@ usually preferable to choose the format corresponding to the current platform. When downloading the sources with DOS ends of lines, prefer 7z format for much smaller file size. - ### Selecting the build system wxWidgets can be built using [CMake](https://cmake.org/) under all platforms. @@ -223,11 +223,11 @@ launchctl setenv WXWIN /Users/dconnet/devtools/wx/wxWidgets-3.1.5 ### Other IDEs -If you use an IDE with wxWidgets support, such as [Code::Blocks][1] or -[CodeLite][2], please use the IDE wizards. +If you use an IDE with wxWidgets support, such as [Code::Blocks][] or +[CodeLite][], please use the IDE wizards. -[1]: https://www.codeblocks.org/ -[2]: https://codelite.org/ +[Code::Blocks]: https://www.codeblocks.org/ +[CodeLite]: https://codelite.org/ If you use another IDE, under Unix you should run `wx-config --cxxflags` and `wx-config --libs` commands separately and copy-and-paste their output to the