Diferencia entre revisiones de «Criterios»

De SIU
Saltar a: navegación, buscar
m
 
(No se muestran 39 ediciones intermedias de 3 usuarios)
Línea 1: Línea 1:
 
__NOINDEX__
 
__NOINDEX__
  
−
==Criterio generales==
+
 
 +
==Criterio de Redacción==
 +
Es importante no usar lenguaje coloquial y hablar en primera persona del plural "Nosotros"  La idea es dejar de hablar del SIU y hablar de nosotros.<br />
 +
Ejemplo:<br />
 +
"El SIU desarrolla aplicaciones para..." '''INCORRECTO'''<br />
 +
"Desarrollamos aplicaciones para..."  '''CORRECTO'''<br />
 +
 
 +
Otro de los cambios importantes es cambiar la manera en la que nos referimos a los usuarios, intentar que el trato sea más ameno. Para evitar el voseo, que es muy propio de CABA también recomendamos escribir en plural.<br />
 +
Ejemplo: "Es importante que tengan en cuenta que antes de migrar la base de datos tendrán que hacer un back up de la información"<br />
 +
También es válido: "Una vez migrada la base es necesario actualizar la versión de apache y por último ejecutar..."<br />
 +
<br />
 +
 +
 
 +
==Criterios Generales==
  
 
Tratá de usar todo como viene por defecto. La idea es que la wiki sea homogénea, si querés hacer algo distinto lo vemos.  
 
Tratá de usar todo como viene por defecto. La idea es que la wiki sea homogénea, si querés hacer algo distinto lo vemos.  
 +
 +
===Sobre las url===
 +
 +
'''siempre''' escribirlas en minúsculas. '''No''' usar acentos. El nombre del sistema siempre hay que escribirlo con siu- delante, siu-sistema.
  
 
===Sobre las tablas===
 
===Sobre las tablas===
  
 
===Sobre las imágenes===
 
===Sobre las imágenes===
 +
Si creés que la imagen podría aparecer en otra página de la wiki o en otra página cualquiera, no la subas a la wiki pedile al área de diseño que te la hostee, de esa manera nos aseguramos que haya una única imagen en todos lados y en caso de se necesario reemplazarla sólo reemplazamos un archivo.
 +
Lo mismo para los logos, si vas poner un logo del sistema usá el mismo que está en la portada.
 +
Tanto las imágenes como cualquier archivo que subas a la wiki debe respetar la siguiente nomenclatura:<br>
 +
 +
'''<tres primeras letras del nombre del sistema en mayúsculas>_nombre de la imagen todo en minúscula separado cada palabra con _ '''
 +
 +
En el caso de que sea una nueva versión del mismo archivo, se deberá agregar al final antepuesto por "_" la letra "v" acompañada del número de versión. <BR>
 +
Ejemplo:<BR>
 +
 +
'''GUA_selector_de_alumnos.png'''  y si se crea una segunda versión: '''GUA_selector_de_alumnos_v2.png''' <br>
 +
 +
En el caso de que haya que volver a cargar una misma versión de una imagen, deberá eliminarse la versión cargada y volver a subirla.<br/>
 +
Cuando se trate de imágenes institucionales del SIU, las mismas deben leerse directametne desde acá: http://www.siu.edu.ar/rd/
 +
 +
=== Sobre los documentos de Google Docs ===
 +
 +
Para embeber un documento de Google Docs en una página de la wiki deben, en primer lugar, publicar el documento -> Archivo -> Publicar en la web -> Insertar - Contenido publicado y configuración - Iniciar publicación.
 +
<br>
 +
Ahí copian el código que les va a brindar Google, del cual solo se va a utilizar la parte de la URL que se encuentra entre comillas:
 +
<br><br>
 +
'''Ejemplo de código de Google''' <br>
 +
<nowiki>
 +
<iframe src="https://docs.google.com/document/d/1WI7YcUFIrPDS6phQcXlubYFAjGxkLOQXWo1AiZlc3mU/pub?embedded=true"></iframe>
 +
</nowiki>
 +
<br><br>
 +
'''Ejemplo de código que utilizaríamos en la wiki''' <br>
 +
<nowiki>
 +
{{#iDisplay:https://docs.google.com/document/d/1WI7YcUFIrPDS6phQcXlubYFAjGxkLOQXWo1AiZlc3mU/pub?embedded=true|100%|1000}}
 +
</nowiki>
 +
<br><br>
 +
El 100% corresponde al ancho del iframe (ocupará el 100% de la página) y el 1000 es la altura en píxeles. Ese último término debe ajustarse de acuerdo al largo del documento (es aproximadamente 800 por cada página de extensión).
 +
 +
=== Sobre el código ===
 +
 +
Para escribir código hay varias maneras:
 +
<nowiki><source lang="php" enclose="div">
 +
</source></nowiki>
 +
<br>Se ve así
 +
<source lang="php" enclose="div">
 +
acá el código
 +
</source>
  
−
Si creés que la imagen podría aparecer en otra página de la wiki o en otra página cualquiera, no la subas a la wiki pedile al área de diseño que te la hostee, de esa manera nos aseguramos que haya una única imagen en todos lados y en caso de se necesario reemplazarla sólo reemplazamos un archivo.
+
otra manera, si te interesa destacar algo en el código:
 +
 
 +
<nowiki><syntaxhighlight lang="php" highlight="1-10">
 +
Donde en highlight="x-x" marcamos qué líneas queremos destacar
 +
</syntaxhighlight> </nowiki>
 +
<br>
 +
Se ve así
 +
<syntaxhighlight lang="php" highlight="1-10">
 +
Donde en highlight="x-x" marcamos qué líneas queremos destacar
 +
</syntaxhighlight>
 +
 
 +
Si querés escribir código y que mediawiki no lo interprete como tal tenés que usar las etiquetas
 +
 
 +
<nowiki><nowiki></nowiki></nowiki>
 +
 
 +
 
 +
En caso de que el recuadro flotante se superponga con otro objeto (por ejemplo, la tabla de contenidos), la solución más simple es delimitar su ancho de la siguiente manera:
 +
<pre><source lang="php" enclose="div" style="width: 450px;">Contenido</source></pre>
 +
 
 +
Se va a ver así:
 +
<source lang="php" enclose="div" style="width: 450px;">Contenido</source>
  
−
Lo mismo para los logos, si vas poner un logo del sistema usá el mismo que está en la portada.
 
  
 
=== Sobre los videos ===
 
=== Sobre los videos ===
  
 
Los videos hay que hosteaslos en Youtube, en la página del SIU y embeberlos en la wiki, para embeberlo hay que usar la siguiente sintaxis:  
 
Los videos hay que hosteaslos en Youtube, en la página del SIU y embeberlos en la wiki, para embeberlo hay que usar la siguiente sintaxis:  
−
Sintaxis:  
+
−
<code> <youtube> acá la url </youtube> </code>
+
<pre><youtube>ID del video</youtube></pre>
 +
 
 +
=== Comentarios en el código ===
 +
 
 +
Para agregar comentarios en el código y que no sean invisibles para el usuario común, la sintaxis es la siguiente:
 +
 
 +
<pre><!-- Contenido del comentario --></pre>
 +
 
 +
=== Quitar la tabla de contenidos ===
 +
 
 +
Si aparece de forma automática una tabla de contenidos en una página que no lo amerita, lo mejor es definir que dicha página no tenga TOC. Para ello la sintaxis es la siguiente:
 +
 
 +
<pre>__NOTOC__</pre>
 +
 
 +
=== Limitar niveles de la tabla de contenido ===
 +
 
 +
Mediante la plantilla TOClimit, se puede limitar cuántos niveles de títulos y subtítulos se muestran en las tablas de contenidos. En el siguiente ejemplo cuyo parámetro es 2, se muestran hasta 2 niveles de títulos (o sea ==). Los títulos de tercer nivel (es decir ===) ya no se mostrarán. El resto del código es para alinear a la derecha y darle margen a la TOC.
 +
 
 +
<pre><span style="float: right; margin: 0 0 15px 15px;">{{TOClimit|2}}</span></pre>
 +
 
 +
=== Links anterior y siguiente al pie ===
 +
 
 +
En las páginas donde hay que seguir pasos, puede resultar útil agregar links del tipo "anterior" y "siguiente" al pie del contenido. Para que dichos links queden alineados y ordenados, la mejor forma es hacerlo mediante una tabla. Aquí va un ejemplo:
 +
 
 +
CODIGO
 +
<pre>{| style="width:100%;"
 +
|-
 +
| [[SIU-Guarani/Version3.11.0/Migracion/Desde sistemas externos/Migracion/Actividades|< Migrar Actividades]] || align="right" | [[SIU-Guarani/Version3.11.0/Migracion/Desde sistemas externos/Migracion/Personas|Migrar Personas >]]
 +
|}</pre>
 +
 
 +
COMO SE VE
 +
http://documentacion.siu.edu.ar/wiki/SIU-Guarani/Version3.11.0/Migracion/Desde_sistemas_externos/Migracion/Calendario_Academico
 +
 
 +
 
 +
=== Resaltar texto para novedades de versión ===
 +
 
 +
Es posible resaltar un texto que indica un cambio respecto de la documentación de la versión anterior del módulo. Este texto adquirirá un formato determinado que se diferenciará del resto. La particularidad es que mediante este procedimiento, cuando se clona el contenido de la documentación para generar el contenido de la versión siguiente, se quita automáticamente el resaltado de los comentarios de la versión anterior. Es decir, si en la versión 3.10.3 por ejemplo había un paso resaltado, en la nueva versión ese paso no estará más resaltado porque se asume que ya no es nuevo. Para que ésto sea posible, el resaltado debe tener el siguiente formato:
 +
<pre>
 +
<span class='comentarios_nueva_version'>Contenido a resaltar</span><!-- comentarios_nueva_version -->
 +
</pre>
 +
Es importante que luego del tag de cierre se incluya el comentario correspondiente para que el script de migración logre identificar fácilmente el resaltado.
 +
 
 +
 
 +
=== Purgar caché de una página ===
 +
 
 +
Para purgar caché de una página, basta con agregar <strong>?action=purge</strong> al final de la URL en cuestión.
 +
 
 +
[[Archivo:EjemploGanacias2016|Ganancias]]

Revisión actual del 13:37 31 may 2024


Criterio de Redacción

Es importante no usar lenguaje coloquial y hablar en primera persona del plural "Nosotros" La idea es dejar de hablar del SIU y hablar de nosotros.
Ejemplo:

"El SIU desarrolla aplicaciones para..." INCORRECTO

"Desarrollamos aplicaciones para..."  CORRECTO

Otro de los cambios importantes es cambiar la manera en la que nos referimos a los usuarios, intentar que el trato sea más ameno. Para evitar el voseo, que es muy propio de CABA también recomendamos escribir en plural.
Ejemplo: "Es importante que tengan en cuenta que antes de migrar la base de datos tendrán que hacer un back up de la información"
También es válido: "Una vez migrada la base es necesario actualizar la versión de apache y por último ejecutar..."


Criterios Generales

Tratá de usar todo como viene por defecto. La idea es que la wiki sea homogénea, si querés hacer algo distinto lo vemos.

Sobre las url

siempre escribirlas en minúsculas. No usar acentos. El nombre del sistema siempre hay que escribirlo con siu- delante, siu-sistema.

Sobre las tablas

Sobre las imágenes

Si creés que la imagen podría aparecer en otra página de la wiki o en otra página cualquiera, no la subas a la wiki pedile al área de diseño que te la hostee, de esa manera nos aseguramos que haya una única imagen en todos lados y en caso de se necesario reemplazarla sólo reemplazamos un archivo. Lo mismo para los logos, si vas poner un logo del sistema usá el mismo que está en la portada. Tanto las imágenes como cualquier archivo que subas a la wiki debe respetar la siguiente nomenclatura:

<tres primeras letras del nombre del sistema en mayúsculas>_nombre de la imagen todo en minúscula separado cada palabra con _

En el caso de que sea una nueva versión del mismo archivo, se deberá agregar al final antepuesto por "_" la letra "v" acompañada del número de versión.
Ejemplo:

GUA_selector_de_alumnos.png y si se crea una segunda versión: GUA_selector_de_alumnos_v2.png

En el caso de que haya que volver a cargar una misma versión de una imagen, deberá eliminarse la versión cargada y volver a subirla.
Cuando se trate de imágenes institucionales del SIU, las mismas deben leerse directametne desde acá: http://www.siu.edu.ar/rd/

Sobre los documentos de Google Docs

Para embeber un documento de Google Docs en una página de la wiki deben, en primer lugar, publicar el documento -> Archivo -> Publicar en la web -> Insertar - Contenido publicado y configuración - Iniciar publicación.
Ahí copian el código que les va a brindar Google, del cual solo se va a utilizar la parte de la URL que se encuentra entre comillas:

Ejemplo de código de Google
<iframe src="https://docs.google.com/document/d/1WI7YcUFIrPDS6phQcXlubYFAjGxkLOQXWo1AiZlc3mU/pub?embedded=true"></iframe>

Ejemplo de código que utilizaríamos en la wiki
{{#iDisplay:https://docs.google.com/document/d/1WI7YcUFIrPDS6phQcXlubYFAjGxkLOQXWo1AiZlc3mU/pub?embedded=true|100%|1000}}

El 100% corresponde al ancho del iframe (ocupará el 100% de la página) y el 1000 es la altura en píxeles. Ese último término debe ajustarse de acuerdo al largo del documento (es aproximadamente 800 por cada página de extensión).

Sobre el código

Para escribir código hay varias maneras: <source lang="php" enclose="div"> </source>
Se ve así

acá el código

otra manera, si te interesa destacar algo en el código:

<syntaxhighlight lang="php" highlight="1-10"> Donde en highlight="x-x" marcamos qué líneas queremos destacar </syntaxhighlight>
Se ve así 

Donde en highlight="x-x" marcamos qué líneas queremos destacar

Si querés escribir código y que mediawiki no lo interprete como tal tenés que usar las etiquetas

<nowiki></nowiki>


En caso de que el recuadro flotante se superponga con otro objeto (por ejemplo, la tabla de contenidos), la solución más simple es delimitar su ancho de la siguiente manera: 

<source lang="php" enclose="div" style="width: 450px;">Contenido</source>

Se va a ver así:

Contenido


Sobre los videos

Los videos hay que hosteaslos en Youtube, en la página del SIU y embeberlos en la wiki, para embeberlo hay que usar la siguiente sintaxis: 

<youtube>ID del video</youtube>

Comentarios en el código

Para agregar comentarios en el código y que no sean invisibles para el usuario común, la sintaxis es la siguiente: 

<!-- Contenido del comentario -->

Quitar la tabla de contenidos

Si aparece de forma automática una tabla de contenidos en una página que no lo amerita, lo mejor es definir que dicha página no tenga TOC. Para ello la sintaxis es la siguiente: 

__NOTOC__

Limitar niveles de la tabla de contenido

Mediante la plantilla TOClimit, se puede limitar cuántos niveles de títulos y subtítulos se muestran en las tablas de contenidos. En el siguiente ejemplo cuyo parámetro es 2, se muestran hasta 2 niveles de títulos (o sea ==). Los títulos de tercer nivel (es decir ===) ya no se mostrarán. El resto del código es para alinear a la derecha y darle margen a la TOC. 

<span style="float: right; margin: 0 0 15px 15px;">{{TOClimit|2}}</span>

Links anterior y siguiente al pie

En las páginas donde hay que seguir pasos, puede resultar útil agregar links del tipo "anterior" y "siguiente" al pie del contenido. Para que dichos links queden alineados y ordenados, la mejor forma es hacerlo mediante una tabla. Aquí va un ejemplo:

CODIGO 

{| style="width:100%;"
|-
| [[SIU-Guarani/Version3.11.0/Migracion/Desde sistemas externos/Migracion/Actividades|< Migrar Actividades]] || align="right" | [[SIU-Guarani/Version3.11.0/Migracion/Desde sistemas externos/Migracion/Personas|Migrar Personas >]]
|}

COMO SE VE http://documentacion.siu.edu.ar/wiki/SIU-Guarani/Version3.11.0/Migracion/Desde_sistemas_externos/Migracion/Calendario_Academico


Resaltar texto para novedades de versión

Es posible resaltar un texto que indica un cambio respecto de la documentación de la versión anterior del módulo. Este texto adquirirá un formato determinado que se diferenciará del resto. La particularidad es que mediante este procedimiento, cuando se clona el contenido de la documentación para generar el contenido de la versión siguiente, se quita automáticamente el resaltado de los comentarios de la versión anterior. Es decir, si en la versión 3.10.3 por ejemplo había un paso resaltado, en la nueva versión ese paso no estará más resaltado porque se asume que ya no es nuevo. Para que ésto sea posible, el resaltado debe tener el siguiente formato: 

<span class='comentarios_nueva_version'>Contenido a resaltar</span><!-- comentarios_nueva_version -->

Es importante que luego del tag de cierre se incluya el comentario correspondiente para que el script de migración logre identificar fácilmente el resaltado.


Purgar caché de una página

Para purgar caché de una página, basta con agregar ?action=purge al final de la URL en cuestión.

Ganancias

Obtenido de «https://documentacion.siu.edu.ar/wiki/index.php?title=Criterios&oldid=100474»