Extensión: Collection

Rastreador de problemas: #Collection
From mediawiki.org
This page is a translated version of the page Extension:Collection and the translation is 14% complete.
Languages:
Manual de extensiones de MediaWiki
Collection
Estado de lanzamiento: estable
Implementación Página especial , MyWiki
Descripción Permite organizar selecciones personales de páginas en una colección que se pueden editar y luego descargar en formatos como PDF, ODF o eBook (XML).
Autor(es)
Última versión 1.8.0 (2019-05-18)
Política de compatibilidad Lanzamientos de screenshots junto con MediaWiki. Master no es compatible con versiones anteriores.
MediaWiki 1.34+
Cambios de la base de datos No
Composer mediawiki/collection
Licencia GNU Licencia Pública general 2.0 o posterior
Descarga
Descargar la extensión.
Git [?]:

README
Ejemplo wiki.openoffice.org
Parámetros
  • $wgCollectionMaxSuggestions
  • $wgCollectionMWServeCert
  • $wgCollectionPortletFormats
  • $wgCollectionRendererSettings
  • $wgCollectionMWServeURL
  • $wgCollectionDisableSidebarLink
  • $wgCollectionMaxArticles
  • $wgCollectionSuggestCheapWeightThreshhold
  • $wgCollectionContentTypeToFilename
  • $wgCollectionShowRenderNotes
  • $wgCollectionMWServeCredentials
  • $wgCollectionDisableDownloadSection
  • $wgCollectionFormatToServeURL
  • $wgCollectionLicenseName
  • $wgCommunityCollectionNamespace
  • $wgCollectionCommandToServeURL
  • $wgCollectionSuggestThreshhold
  • $wgCollectionPortletForLoggedInUsersOnly
  • $wgCollectionArticleNamespaces
  • $wgCollectionPODPartners
  • $wgCollectionFormats
  • $wgCollectionLicenseURL
Hooks que usa
Descargas trimestrales 185 (Ranked 45th)
Wikis públicos que lo utilizan 1,243 (Ranked 219th)
Traduce la extensión Collection si está disponible en translatewiki.net
Asuntos Tareas abiertas · Reportar un bug

La extensión Collection permite a un usuario organizar selecciones personales de páginas en una colección. Las colecciones pueden ser:

  • editadas y estructuradas como capítulos
  • descargadas y compartidas
  • solicitar un libro impreso a partir de ella por un 1$

En un momento dado también podrían ser:

See the press release Wikis Go Printable for more information on the original project.

Documentation & Support

The Collection extension uses the Proton service to do most of its heavy lifting. It used OCG before.

You can use the IRC channel #wikimedia-services connect to get in touch with developers.

Use the MediaWiki-extensions-Collection project in Phabricator in order to report bugs.

A detailed guide on how to prepare your wiki (templates, help pages, categories) if you setup the extension is available at meta.wikimedia.org.

mwlib

Older versions of the Collection extension used the mwlib library. Documentation for mwlib can be found at http://mwlib.readthedocs.org/, and there is a Google group for support and discussion of mwlib and mwlib.rl. mwlib developers have also been spotted on the pediapress IRC channel:

  • Server: irc.freenode.net
  • Canal: #pediapress

Screencast

There is a screencast demoing the basic functionality available at YouTube (in German) (2:45 minutes).

Creating cross-wiki article collections

The OCG service supported this, but the Collection extension does not (yet — patches welcome!). You can use the low-level mw-ocg-bundler and mw-ocg-latexer tools to create cross-wiki collections, or use https://pediapress.com/collection/ for this purpose, see ticket 408.

Instalación

  • Descarga y extrae los archivos en un directorio denominado «Collection» dentro de la carpeta extensions/.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Collection
  • Añade el siguiente código en la parte final de tu archivo LocalSettings.php : 
    wfLoadExtension( 'Collection' );
  • Configure the extension as required
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Please also read the included README for detailed configuration instructions of the extension.

Configuración

The documentation below is out of date. Installing a development instance contains the most up-to-date documentation.

For the older mwlib-based service, see Installation and Configuration of the Collection Extension and Customization via System Messages.

Generating PDFs, OpenDocument- & DocBook-Exports

It's easy to enable PDF (ODF, DocBook) support with this extension. It is configured by default to use the server https://tools.pediapress.com/. Therefore (low traffic) sites that are accessible from the internet don't need to install their own PDF server. Steps:

  • Simply install and configure the Collection extension using the default value http://tools.pediapress.com/mw-serve/ for $wgCollectionMWServeURL (see README of the Collection extension for instructions) and make sure the MediaWiki API (api.php) is enabled on your MediaWiki installation.
  • Some users report that installing PDFtk is necessary.

No installation of Python, ReportLab, mwlib etc. required! Note however, that in order to use this service, your wiki must be accessible from the internet and must be either accessible for non-logged-in users or login credentials must be configured (see README for instructions).

Have a look at the Solar system, example article from the English language Wikipedia, rendered as PDF using this technology.

Set up your own render server

If you either have a wiki which is not accessible from the outside or your site has high traffic, you need to install your own render server. The server is included with mwlib and can be used as a stand-alone HTTP server (which is the default protocol) or as FastCGI or SCGI server or as a CGI script.

Requirements and steps

Installing mwlib has a number of additional prerequisites. Please refer to the official installation documentation. Guides for your specific environment may also be useful, see below.

Otras guías

Advanced and optional configuration

Most wikis will never need to know about what follows. Check the main PHP file to see all the global variables you can configure and their meaning. Some of them are useful to tweak the export in many cases.

Print on demand

Since version 1.6 (r113740) the extension offers the variable $wgCollectionPODPartners that is used to define available providers of the print-on-demand service.

By default it uses PediaPress service: 

$wgCollectionPODPartners = [
    'pediapress' => [
        'name' => 'PediaPress',
        'url' => 'http://pediapress.com/',
        'posturl' => 'http://pediapress.com/api/collections/',
        'infopagetitle' => 'coll-order_info_article'
    ],
];

It is an array of elements, every of them will be listed as a possible print-on-demand provider. The parameters are:

name
short name of the provider
url
URL to point for more information if there is no information page
posturl
URL of the actual printing web service
infopagetitle
MediaWiki system message name (as visible in the MediaWiki: namespace) that contains page title of the page that will be used to shortly describe the provider. The default (for PediaPress) is MediaWiki:Coll-order info article, which defaults to PediaPress order information. If this page exists, it is used to display information about PediaPress book printing service.

It is also possible to disable print on demand altogether by setting: 

$wgCollectionPODPartners = false;

Please see task T35536 and commit entry for more information about this feature.

You can also configure which file formats are available: 

$wgCollectionFormats = [
    'rl' => 'PDF', # enabled by default
    'odf' => 'ODT',
    'docbook' => 'DocBook XML',
    'xhtml' => 'XHTML 1.0 Transitional',
    'epub' => 'e-book (EPUB)',
    'zim' => 'Kiwix (OpenZIM)',
];

See README for more configuration options.

User rights for saving books

To allow users to save books in both their user space and the community space, add the following lines to your LocalSettings.php: 

$wgGroupPermissions['user']['collectionsaveascommunitypage'] = true;
$wgGroupPermissions['user']['collectionsaveasuserpage'] = true;

Add the links at another place

If you want to add the links at another place, e.g. in the menu "Personal Tools", you can do that by adding them into the according portlet. For example, in the Vector skin you can do that by adding to the file skins/Vector.php so that it looks like this: 

	<h3><?php $this->msg( 'personaltools' ) ?></h3>
	<ul<?php $this->html( 'userlangattributes' ) ?>>
<?php
		$personalTools = $this->getPersonalTools();

		/* Links to create a PDF file/a book start */
		if ( class_exists('CollectionHooks') ) {
			$collectionURLs = CollectionHooks::getPortlet($this->getSkin());

			if ( $collectionURLs !== false ) {
				/* Put the links of the Collection extension below the last item. */
				$personalTools += $collectionURLs;
			}
		}
		/* Links to create a PDF file/a book end */

		foreach ( $personalTools as $key => $item ) {
			echo $this->makeListItem( $key, $item );
		}

You can still modify the order of the links in the portlet by modifying $personalTools directly before the foreach loop is executed.

The above implementation has the drawback, that the two newly inserted links do not show their tooltip. A solution for that is still outstanding and would be greatly appreciated.

Setting book prefix

To change the default prefix for book name edit the message MediaWiki:Coll-community book prefix.

Cache

Recent versions store rendered "books" in a cache. Collections which have been previously exported by users should be available for download almost immediately, rather than after several minutes of rendering; the cached version can be updated by following a link offered in the download page.

Help improving the extension

If you want to help to make the extension better, you can:

Printed Books with PediaPress

Printed Wikipedia books as offered by PediaPress

PediaPress is a service that offers printed books based from wiki content. This service is seamlessly integrated in this extension (can be disabled).

Relacionado

Véase también

Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:Collection/es&oldid=6137351"