GithubHelp home page GithubHelp logo

collective / collective.spanishdocumentation Goto Github PK

View Code? Open in Web Editor NEW

This project forked from macagua/collective.spanishdocumentation

17.0 119.0 122.0 42.66 MB

Documentación oficial de Plone en Español Zope/Plone.

Home Page: http://plone-spanish-docs.rtfd.org

Makefile 18.27% Python 37.65% CSS 8.63% JavaScript 3.07% HTML 32.37%

collective.spanishdocumentation's Introduction

Documentación comunitaria de Plone en Español

Repositorio de documentación aportado por las comunidades Plone México, Plone Venezuela y Plone Conosur.

El almacenamiento de este material está disponible en un repositorio Git en GitHub.com "collective.spanishdocumentation". Si usted tiene una credenciales en este servidor y desea convertirse en un colaborador ejecute el siguiente comando:

$ git clone [email protected]:collective/collective.spanishdocumentation.git

Si usted no tiene las credenciales de acceso al repositorio Git en GitHub.com "collective.spanishdocumentation" o simplemente solo desea obtener y compilar esta documentación ejecute el siguiente comando:

$ git clone https://github.com/collective/collective.spanishdocumentation.git

Crear entorno virtual de Python para reconstruir este proyecto:

# aptitude install python-setuptools git-core
# easy_install virtualenv
$ cd $HOME ; mkdir $HOME/virtualenv ; cd $HOME/virtualenv
$ virtualenv --python=/usr/bin/python sphinx
$ source virtualenv/sphinx/bin/activate

Ahora puede generar la documentación de HTML, con los siguiente comandos:

(sphinx)$ cd collective.spanishdocumentation/
(sphinx)$ python bootstrap.py
(sphinx)$ ./bin/buildout -vN
(sphinx)$ ./bin/sphinx

Ahora se puede abrir collective.spanishdocumentation/build/html/index.html desde su navegador Web favorito.

Para obtener la documentación en PDF ejecute los siguientes comandos:

$ source virtualenv/sphinx/bin/activate
(sphinx)$ cd ./collective.spanishdocumentation/build
(sphinx)$ make latex
(sphinx)$ make latexpdf

Ahora se puede abrir collective.spanishdocumentation/build/latex/DocumentacionEspanolPlone.pdf con sus programas de visor de PDF favorito (Evince, Acrobat Reader, ...)

En primer lugar, debe aprender los fundamentos de Sphinx que es un reStructuredText extendido.

Su editor debe codificar el texto en utf-8 si le gusta lo que está leyendo. Si su editor de texto favorito no reconoce esta codificación (en la actualidad, eso es bien extraño), entonces cambie de editor de texto.

Truco

Para vi, emacs y algunos otros editores de texto soportan utf-8 de forma automática al abrir un archivo de Sphinx, el lugar en primera línea de la siguiente marca (como en este archivo):

.. -*- coding: utf-8 -*-

El uso del carácter de tabulación en el texto fuente para las distintas desplazamientos y indentaciones está estrictamente prohibido. Utilice siempre espacios para este fin. Todos los editores de texto ofrecen opciones avanzadas para insertar espacios al pulsar la tecla TAB. No tiene excusa si es necesario.

Sphinx y ReStructuredText no imponer estilo de subrayado para diferentes niveles de secciones de un documento. Todo se deja a la discreción editores. Para mantener la coherencia nosotros adoptamos la siguiente convención:

==============================================
Titulo de capitulo (uno solo por cada archivo)
==============================================
...
Sección del nivel 1
===================
...
Sección del nivel 2
-------------------
...
Sección del nivel 3
...................
...
Sección del nivel 4
~~~~~~~~~~~~~~~~~~~
...
Sección del nivel 5
:::::::::::::::::::
...
Sección del nivel 6
*******************
...
Sección del nivel 7
+++++++++++++++++++

No es necesario ni deseable ir más allá del nivel 4. Cuando la generación del documento allá completado, el nivel de las secciones básicas de un archivo depende del nivel de anidamiento del archivo en la estructura general de documento. Para generar el HTML, no es un problema, pero en LaTeX limita la superposición de las secciones a 6 niveles.

Wow, estás contento con tu excelente trabajo. Y le gustaría compartirlo con todo el mundo. Al igual que cuando "contribuidor" de código fuente, las pruebas unitarias no deben mostrar ningún error, compruebe en primer lugar:

  • Que el comando make html no genere ningún error o advertencia.
  • Que su redacción no posea ningún error de ortografía.
  • Los enlaces de hipertexto que se ha agregado o cambiado (glosario, enlaces externos explícitos, referencias a las secciones, ...) funcionan correctamente.

Aparte de las capturas de pantalla - ¡Uy, lo siento - las capturas de pantalla!, las imágenes Sphinx se inserta en el documento debe ir acompañada de su versión "Fuente" en un formato público interoperables, y para que el editor pueda abrir el archivo fuente que este disponible. Las imágenes deben estar preferentemente en el formato PNG.

Además, durante cada inserción o cambio de imagen, usted debe verificar y ajustar si es necesario la representación PDF, a sabiendas de las limitaciones la imagen a tamaño del papel final.

Ejemplo :

.. gs-map.mm: imagen de mapa mental de los servicios de GenericSetup. Creado con FreeMind

.. image:: gs-map.png
   :align: center
   :alt: imagen de mapa mental de los servicios de GenericSetup

.. figure::  screenshot.jpg
   :align:   center
   :alt: Captura de pantalla del programa de mapa mental

   Captura de pantalla del programa de mapa mental

Aplicaciones gráficas recomendadas

Diagramas : Graphviz

Editor emacs: usted puede agregar a emacs el módulo rst.el que añade un par de comandos y la sintaxis de la documentación a los escritores simpatizantes de Sphinx y reStructuredText.

Pregunta : He añadido una entrada del índice o un nuevo término en el glosario y no se actualiza cuando compilo el documento.

Respuesta : El índice de Sphinx es a veces es desorientado y la gestión de la dependencia a veces, mejor. Por lo tanto, todo se debe reiniciar ejecutando el comando make clean dentro del directorio collective.spanishdocumentation/build/.

collective.spanishdocumentation travis-ci build status collective.spanishdocumentation ReadTheDocs build status

¿Tiene alguna idea?, ¿Encontró un error? Por favor, hágalo saber registrando un ticket de soporte.

collective.spanishdocumentation's People

Contributors

cguardia avatar emilopez avatar kamihacker avatar macagua avatar misaelnieto avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

collective.spanishdocumentation's Issues

Error en clonación de pypi

Al ejecutar el bootstrap.py se produce el siguiente error:

python macagua.buildout.pypimirror/bootstrap.py
Traceback (most recent call last):
File "macagua.buildout.pypimirror/bootstrap.py", line 97, in
pythonpath = ws.find(pkg_resources.Requirement.parse(requirement)).location
AttributeError: 'NoneType' object has no attribute 'location'

Se tomó en cuenta la clonación del repositorio, inicialización de virtualenv, y ejecución de bootstrap.py con el virtualenv activo.

MissingSectionHeaderError: File contains no section headers.

Buen día,
Quisiera solicitarle su apoyo, con Plone 4, hace algún tiempo quiero instalar algunos complementos a mi sitio pero no da resultado. Ahora al querer correr el Buildout da el error: MissingSectionHeaderError: File contains no section headers.

adminplone@plonevm:~/Plone/zinstance$ ./bin/buildout -vN
While:
Initializing.

An internal error occurred due to a bug in either zc.buildout or in a
recipe being used:
Traceback (most recent call last):
File "/home/adminplone/Plone/buildout-cache/eggs/zc.buildout-2.2.1-py2.7.egg/zc/buildout/buildout.py", line 1941, in main
user_defaults, command, args)
File "/home/adminplone/Plone/buildout-cache/eggs/zc.buildout-2.2.1-py2.7.egg/zc/buildout/buildout.py", line 221, in init
data['buildout'].copy(), override, set()))
File "/home/adminplone/Plone/buildout-cache/eggs/zc.buildout-2.2.1-py2.7.egg/zc/buildout/buildout.py", line 1558, in _open
result = zc.buildout.configparser.parse(fp, filename, _default_globals)
File "/home/adminplone/Plone/buildout-cache/eggs/zc.buildout-2.2.1-py2.7.egg/zc/buildout/configparser.py", line 207, in parse
raise MissingSectionHeaderError(fpname, lineno, line)
MissingSectionHeaderError: File contains no section headers.
file: /home/adminplone/Plone/zinstance/buildout.cfg, line: 1
'\xef\xbb\xbf############################################\n'
adminplone@plonevm:~/Plone/zinstance$

Alguien que me pueda indicar donde tengo el error o como puedo resolverlo. Gracias.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.