Jump to content

Parsoid

Rastreador de problemas: #parsoid
From mediawiki.org
This page is a translated version of the page Parsoid and the translation is 29% complete.
Languages:
Proyectos de la Fundación Wikimedia
Parsoid
Un analizador sintáctico de texto wiki en tiempo de ejecución bidireccional. Convierte de ida y vuelta entre código wiki y DOM HTML/XML con RDFa.
Grupo: Content Transform Team
Inicio: 2011-10
Equipo: Arlo Breault, C.Scott Ananian, Isabelle Hurbain-Palatin, Mateus Santos, Yiannis Giannelos
Backlog: #parsoid
Líder: Subramanya Sastry
Gestión: Sérgio Lopes
Interpretación artística del motor de ejecución para wikis Parsoid compatible con HTML5 y RDFa

Parsoid es una biblioteca que permite convertir de ida y vuelta entre código wiki y HTML. La aplicación original se escribió en JavaScript (utilizando Node.js) y se empezó a ejecutar en los servidores de Wikimedia en diciembre de 2012. En 2019, Parsoid se reescribió en PHP, y esta versión sustituyó a la anterior en JS en los servidores de Wikimedia en diciembre de 2019. Parsoid está en proceso de integración en el núcleo de MediaWiki, con el objetivo de reemplazar a la larga el analizador sintáctico nativo actual de MediaWiki. In early 2024, Parsoid began to be used on some production wikis as the default parser for read views.

Parsoid (en su versión PHP) se ha incluido nativamente en MediaWiki desde la versión 1.35, publicada en septiembre de 2020. En instalaciones ajenas a Wikimedia, Parsoid/JS gozaba de servicio técnico hasta la finalización del ciclo de vida de MediaWiki 1.31 (LTS), en septiembre de 2021. The legacy parser will still be supported in MediaWiki 1.43 (LTS).

Detalles técnicos

Parsoid es una aplicación capaz de traducir en ambas direcciones entre la sintaxis código wiki de MediaWiki y un modelo de documentos HTML/RDFa equivalente, compatible con procesamiento automatizado y edición enriquecida mejorada.

Ha estado en desarrollo desde 2012 por un equipo especial de la Wikimedia Foundation. Lo utilizan ampliamente VisualEditor , Structured discussions , Traductor de contenido y otras aplicaciones.

Parsoid tiene como objeto brindar una conversión bidireccional impecable, que evite pérdidas de información y «diferencias sucias».

En los wikis de Wikimedia, para varios fines, Parsoid actualmente se ejecuta en un servidor intermediario tras RESTBase , que almacena el HTML que Parsoid procesa. Se espera que RESTBase se sustituya con el tiempo con una antememoria más estrechamente integrada con MediaWiki.

Para conocer más detalles sobre el proyecto en conjunto, consulte esta entrada de blog de marzo de 2013. Para obtener información sobre el modelo HTML utilizado, vea la especificación del DOM de MediaWiki.

Originalmente, Parsoid se estructuraba como servicio web escrito en JavaScript, haciendo uso de Node.js. Una charla técnica de febrero de 2019 (diapositivas), así como una entrada de blog, describen el proceso de reescritura en PHP. La API de extensiones de Parsoid se está desarrollando activamente en estos momentos; una charla técnica de agosto de 2020 describe esta labor.

Repositorio en GitHub: https://github.com/wikimedia/parsoid

Uso

Instalación

In MediaWiki 1.35 Parsoid/PHP is included in the bundle and loaded automatically by Visual Editor. No hace falta configuración alguna en MediaWiki 1.35 y versiones posteriores.

Parsoid exports an internal REST API which was historically used by RESTBase and not accessible outside the WMF internal cluster. This is no longer required for Visual Editor or core read views, and the internal API is being deprecated and is planned for removal in MW 1.43.

Parsoid is nominally a composer library used by mediawiki core. If you still require the internal API for some reason, you can explicitly load Parsoid "as an extension" by adding the following to LocalSettings.php: 

wfLoadExtension( 'Parsoid', "$IP/vendor/wikimedia/parsoid/extension.json" );

Any remaining third-party users of the internal Parsoid API are strongly encouraged to migrate to the core REST HTML page endpoint which provides equivalent functionality.

Desarrollo

El desarrollo tiene lugar en el Parsoid Git repository. Las revisiones de código enviado se llevan a cabo en Gerrit. See Gerrit/Getting started to set up an account for yourself.

If you use the MediaWiki-Vagrant development environment using a virtual machine, you can simply add the role visualeditor to it and it will set up a working Parsoid along with Extension:VisualEditor . (This may have been broken by the switch to Parsoid/PHP: T258940)

Note that the most-recently released version of Parsoid is written in PHP, and installation of Parsoid/PHP is what is described below. This is what you should use if you are running MediaWiki 1.35 or later. Check Parsoid/JS if you are running the old version of Parsoid written in JavaScript, and used for MW 1.34 and earlier.

Linking a developer checkout of Parsoid

In a standard MediaWiki installation, Parsoid is included from MediaWiki as a composer library, wikimedia/parsoid.

For development purposes you usually want to use a git checkout of Parsoid, and not the version bundled in MediaWiki core as a composer library. The following lines added to LocalSettings.php allow use of a git checkout of Parsoid (optionally), load the Parsoid REST API with wfLoadExtension (rather than using the version bundled in VisualEditor) and manually do the Parsoid configuration which is usually done by VisualEditor: 

$parsoidInstallDir = 'vendor/wikimedia/parsoid'; # bundled copy
#$parsoidInstallDir = '/my/path/to/git/checkout/of/Parsoid';

// For developers: ensure Parsoid is executed from $parsoidInstallDir,
// (no la versión incluida en mediawiki-core de manera predeterminada)
// Must occur *before* wfLoadExtension()
if ( $parsoidInstallDir !== 'vendor/wikimedia/parsoid' ) {
    function wfInterceptParsoidLoading( $className ) {
        // Only intercept Parsoid namespace classes
        if ( preg_match( '/(MW|Wikimedia\\\\)Parsoid\\\\/', $className ) ) {
           $fileName = Autoloader::find( $className );
           if ( $fileName !== null ) {
               require $fileName;
           }
        }
    }
    spl_autoload_register( 'wfInterceptParsoidLoading', true, true );
    // AutoLoader::registerNamespaces was added in MW 1.39
    AutoLoader::registerNamespaces( [
        // Keep this in sync with the "autoload" clause in
        // $parsoidInstallDir/composer.json
        'Wikimedia\\Parsoid\\' => "$parsoidInstallDir/src",
    ] );
}

wfLoadExtension( 'Parsoid', "$parsoidInstallDir/extension.json" );

# Configurar Parsoid manualmente
$wgVisualEditorParsoidAutoConfig = false;
$wgParsoidSettings = [
    'useSelser' => true,
    'rtTestMode' => false,
    'linting' => false,
];
$wgVirtualRestConfig['modules']['parsoid'] = [
    // URL a la instalación de Parsoid.
    // Si Parsoid no se ejecuta localmente, cambie $wgServer para que coincida con el anfitrión no local 
    // While using Docker in macOS, you may need to replace $wgServer with http://host.docker.internal:8080
    // While using Docker in linux, you may need to replace $wgServer with http://172.17.0.1:8080
    'url' => $wgServer . $wgScriptPath . '/rest.php',
    // «Dominio» de Parsoid; vea más abajo (opcional; rara vez hace falta)
    // 'domain' => 'localhost',
];
unset( $parsoidInstallDir );

These lines are not necessary for most users of VisualEditor, who can use auto-configuration and the bundled Parsoid code included in MediaWiki 1.35 and VisualEditor, but they will be required for most developers.

If you're serving MediaWiki with Nginx, you'll need to also add something like this in your server block (Assuming your MediaWiki setup has its files residing in /w/): 

location /w/rest.php/ {
    try_files $uri $uri/ /w/rest.php?$query_string;
}

To test proper configuration, visit {$wgScriptPath}/rest.php/{$domain}/v3/page/html/Main%20Page where $domain is the hostname in your $wgCanonicalServer. (Note that production WMF servers do not expose the Parsoid REST API to the external network.)

Ejecutar las pruebas

To run all parser tests and mocha tests: 

$ composer test

The parser tests have quite a few options now which can be listed using php bin/parserTests.php --help.

If you have the environment variable MW_INSTALL_DIR pointing to a configured MediaWiki installation, you can run some additional tests with: 

$ composer phan-integrated

Converting simple wikitext

You can convert simple wikitext snippets from the command line using the parse.php script in the bin/ directory: 

echo 'Foo' | php bin/parse.php

The parse script has a lot of options. php bin/parse.php --help gives you information about this.

Depuración de Parsoid (para desarrolladores)

See Parsoid/Debugging for debugging tips.

Integración continua

A octubre de 2021

Parsoid is always available as a library since it is a composer dependency of MediaWiki core. But two pieces are not enabled:

  • Parsoid ServiceWiring
  • Parsoid's external REST api

The test runner Quibble would enable it if it detects mediawiki/services/parsoid.git has been cloned as part of the build. In which case it:

  • points the autoloader for Wikimedia\Parsoid to the cloned code (effectively replacing the version installed by composer)
  • Load the extension wfLoadExtension( 'Parsoid', '/path/to/cloned/repo' );

The ServiceWiring should be enabled in MediaWiki starting with 1.38.

The REST API would theorically never get merged in MediaWiki: a) it has never been exposed to the public in production, it is an internal API used by RESTBase which is going away; b) it never has been security audited and c) it is redundant with the enterprise MediaWiki API. The solution will be for VisualEditor to invoke Parsoid directly via the VisualEditor Action API which would save a round trip through the REST API.

Loading the extension is thus a hack which enables using interfaces subject to change and which we don't really want people to use yet.

For most purposes, parsoid should thus not be added as a CI dependency, the only exception as of October 2021 is the Disambiguator MediaWiki extension.

Loading parsoid as an extension let us run MediaWiki integration test jobs against mediawiki/services/parsoid.git (such as Quibble, apitesting) and ensure Parsoid and MediaWiki work together.

An extension may be able to write tests with Parsoid even when the repository has not been cloned. Since it is a composer dependency of MediaWiki core the MediaWiki\Parsoid namespace is available, but the service wiring part is not (it is extension/src in the Parsoid repository and exposed as the \MWParsoid namespace). The ParsoidTestFileSuite.php code would only run the parser tests if Parsoid has been loaded (which should be the default with MediaWiki 1.38).

For CI, Parsoid is tested against the tip of mediawiki, whereas mediawiki is tested with the composer dependency. In case of a breaking change, the Parsoid change get merged first (which breaks its CI but not MediaWiki one) and MediaWiki get adjusted when Parsoid is updated. It is thus a one way change.

Release build

For MediaWiki release builds, we have an integration of Parsoid ServiceWiring into VisualEditor in order to have VisualEditor work without further configuration (beside a wfLoadExtension( 'VisualEditor' )). The release build also enables the REST API and hook everything us so that parsoid works out of the box. This is done by copying a bit of parsoid code into VisualEditor which is not in the master branch of VisualEditor since that would be obsolete as soon as Parsoid is updated. Instead the code is maintained in two places.

Documentos técnicos

See also

Contact

If you need help or have questions/feedback, you can contact us in #mediawiki-parsoid connect or the wikitext-l mailing list. If all that fails, you can also contact us by email at content-transform-team at the wikimedia.org domain.

Retrieved from "https://www.mediawiki.org/w/index.php?title=Parsoid/es&oldid=6730330"