Variants
Views
Actions

Difference between revisions of "Cppreference:Archives"

From cppreference.com
(Blanked the page)
m (Reverted edits by Strings (talk) to last revision by Zetrov)
Line 1: Line 1:
 +
{{title|Archives for offline viewing}}
  
 +
For convenience, several versions of the wiki suitable for offline viewing are available.
 +
 +
===Html book===
 +
 +
This html book is an offline copy of the website with unnecessary UI elements stripped out. Choose this if you just want to access cppreference.com via a browser while without internet connection.
 +
 +
{|
 +
| rowspan=2 style="padding-right:1em;" | 7 June 2019<br/>{{small|[[Cppreference:Old archives|Old versions]]}}
 +
| [[File:html_book_20190607.zip]]
 +
|-
 +
| [[File:html_book_20190607.tar.xz]]
 +
|}
 +
 +
===Raw archive===
 +
 +
This archive is a raw copy created using [http://www.gnu.org/software/wget/ Wget]. Note that this archive is not useful for viewing as-is, please use the HTML book instead. Note: the utility scripts and a makefile are contained in this package, so it can be used as full upstream source.
 +
 +
{|
 +
| rowspan=2 style="padding-right:1em;" | 7 June 2019<br/>{{small|[[Cppreference:Old archives|Old versions]]}}
 +
| [[File:cppreference-doc-20190607.zip]]
 +
|-
 +
| [[File:cppreference-doc-20190607.tar.xz]]
 +
|}
 +
 +
===Unofficial Release===
 +
 +
An unofficial fork that is updated more frequently can be found in [https://github.com/PeterFeicht/cppreference-doc this] git repository.
 +
 +
{|
 +
| rowspan=3 style="padding-right:1em;" | 28 September 2019<br/>{{small|[https://github.com/PeterFeicht/cppreference-doc/releases Old versions]}}
 +
| [https://github.com/PeterFeicht/cppreference-doc/releases/download/v20190928/html-book-20190928.zip html-book-20190928.zip]
 +
|-
 +
| [https://github.com/PeterFeicht/cppreference-doc/releases/download/v20190928/html-book-20190928.tar.xz html-book-20190928.tar.xz]
 +
|-
 +
| [https://github.com/PeterFeicht/cppreference-doc/releases/tag/v20190928 Other files (qch and raw archive)]
 +
|}
 +
 +
===Devhelp book===
 +
 +
[https://wiki.gnome.org/Apps/Devhelp Devhelp] is a documentation browser for GTK/Gnome.
 +
 +
The book is available as {{tt|cppreference-doc-en-html}} {{tt|deb}} package in the official [https://packages.debian.org/search?keywords=cppreference&searchon=names&suite=all&section=all Debian ] and [http://packages.ubuntu.com/search?keywords=cppreference&searchon=names&suite=all&section=all Ubuntu] repositories.
 +
 +
For arch users, the package {{tt|cppreference-devhelp}} could be found [https://aur.archlinux.org/packages/cppreference-devhelp/ here], which can be installed from AUR by tools like yaourt.
 +
 +
===Qt help book===
 +
 +
{{tt|qch}} is a documentation format for use in the Qt tools such as [https://wiki.qt.io/Qt_Creator QtCreator] or [http://doc.qt.io/qt-5/qtassistant-index.html Qt Assistant].
 +
 +
The {{tt|qch}} book below contains a version of the html book, adapted for use with the Qt tools. Search also works.
 +
 +
:'''Note''': Old versions of QtCreator or QtAssistant display the documentation improperly. If you see bad formatting, please update these programs. The oldest versions that display the contents correctly are QtCreator v3.0 and QtAssistant v4.8.6.
 +
 +
{|
 +
|-
 +
| rowspan=2 style="padding-right:1em;" | 7 June 2019<br/>{{small|[[Cppreference:Old archives|Old versions]]}}
 +
| [[File:qch_book_20190607.zip]]
 +
|-
 +
| [[File:qch_book_20190607.tar.xz]]
 +
|}
 +
 +
The book is available as {{tt|cppreference-doc-en-qch}} {{tt|deb}} package in the official [https://packages.debian.org/search?keywords=cppreference&searchon=names&suite=all&section=all Debian ] and [http://packages.ubuntu.com/search?keywords=cppreference&searchon=names&suite=all&section=all Ubuntu] repositories.
 +
 +
The book is also provided by AUR package [https://aur.archlinux.org/packages/cppreference-qt/ cppreference-qt] for Arch Linux users.
 +
 +
===Doxygen tag file===
 +
[http://doxygen.nl/ Doxygen] is a tool to automatically generate documentation from source code comments. It supports automatic linking of C++ names to external documentation via [http://www.stack.nl/~dimitri/doxygen/manual/external.html tag file] functionality. Two tag files are provided in the "html book" archive mentioned above:
 +
 +
* '''local''': use the {{tt|cppreference-doxygen-local.tag.xml}} file to link to the local "html book" archive at the default install location.
 +
 +
* '''web''': {{tt|cppreference-doxygen-web.tag.xml}} to link directly to the cppreference.com website.
 +
 +
 +
In order to support external cppreference documentation, Doxyfile needs to be modified as follows:
 +
 +
* If the link target is local archive, add the following line:
 +
 +
{{tt|1=TAGFILES += "location/of/cppreference-doxygen-local.tag.xml=/location/of/html/book/root/"}}
 +
 +
* If the link target is cppreference.com, add the following line:
 +
 +
{{tt|1=<nowiki>TAGFILES += "location/of/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/"</nowiki>}}
 +
 +
===Manpages===
 +
 +
Automatically generated man pages are maintained [https://github.com/jeaye/stdman here]. Installation notes are included in the README and updates follow the offline archive releases.
 +
 +
===Bugs===
 +
 +
All bugs in the offline archives should be reported either to the [http://en.cppreference.com/w/Cppreference_talk:Archives talk page] or to the [https://github.com/p12tic/cppreference-doc/issues issues page] of the cppreference-doc github project.
 +
 +
===See also===
 +
 +
The utility scripts are maintained in [http://github.com/p12tic/cppreference-doc this] git repository.
 +
 +
The debian packaging information is maintained in [http://github.com/p12tic/cppreference-doc-debian this] git repository.
 +
 +
An independently-maintained CHM (Windows help) archive can be found in [https://github.com/crea7or/cppreference2mshelp this] git repository.
 +
 +
 +
{{langlinks|ja|zh}}

Revision as of 13:08, 8 January 2020


For convenience, several versions of the wiki suitable for offline viewing are available.

Contents

Html book

This html book is an offline copy of the website with unnecessary UI elements stripped out. Choose this if you just want to access cppreference.com via a browser while without internet connection.

7 June 2019
Old versions 		File:html book 20190607.zip
File:html book 20190607.tar.xz

Raw archive

This archive is a raw copy created using Wget. Note that this archive is not useful for viewing as-is, please use the HTML book instead. Note: the utility scripts and a makefile are contained in this package, so it can be used as full upstream source.

7 June 2019
Old versions 		File:cppreference-doc-20190607.zip
File:cppreference-doc-20190607.tar.xz

Unofficial Release

An unofficial fork that is updated more frequently can be found in this git repository.

28 September 2019
Old versions 		html-book-20190928.zip
html-book-20190928.tar.xz
Other files (qch and raw archive)

Devhelp book

Devhelp is a documentation browser for GTK/Gnome.

The book is available as cppreference-doc-en-html deb package in the official Debian and Ubuntu repositories.

For arch users, the package cppreference-devhelp could be found here, which can be installed from AUR by tools like yaourt.

Qt help book

qch is a documentation format for use in the Qt tools such as QtCreator or Qt Assistant.

The qch book below contains a version of the html book, adapted for use with the Qt tools. Search also works.

Note: Old versions of QtCreator or QtAssistant display the documentation improperly. If you see bad formatting, please update these programs. The oldest versions that display the contents correctly are QtCreator v3.0 and QtAssistant v4.8.6.
7 June 2019
Old versions 		File:qch book 20190607.zip
File:qch book 20190607.tar.xz

The book is available as cppreference-doc-en-qch deb package in the official Debian and Ubuntu repositories.

The book is also provided by AUR package cppreference-qt for Arch Linux users.

Doxygen tag file

Doxygen is a tool to automatically generate documentation from source code comments. It supports automatic linking of C++ names to external documentation via tag file functionality. Two tag files are provided in the "html book" archive mentioned above:

  • local: use the cppreference-doxygen-local.tag.xml file to link to the local "html book" archive at the default install location.
  • web: cppreference-doxygen-web.tag.xml to link directly to the cppreference.com website.


In order to support external cppreference documentation, Doxyfile needs to be modified as follows:

  • If the link target is local archive, add the following line:

TAGFILES += "location/of/cppreference-doxygen-local.tag.xml=/location/of/html/book/root/"

  • If the link target is cppreference.com, add the following line:

TAGFILES += "location/of/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/"

Manpages

Automatically generated man pages are maintained here. Installation notes are included in the README and updates follow the offline archive releases.

Bugs

All bugs in the offline archives should be reported either to the talk page or to the issues page of the cppreference-doc github project.

See also

The utility scripts are maintained in this git repository.

The debian packaging information is maintained in this git repository.

An independently-maintained CHM (Windows help) archive can be found in this git repository.

Retrieved from "https://en.cppreference.com/mwiki/index.php?title=Cppreference:Archives&oldid=114935"