Plantillas - Glioce/Documentacion_GMS GitHub Wiki

Para cada tipo de contenido, debes usar una base html determinada, con el fin de mantener un estándar en los archivos del manual.

Plantilla de entradas

Si vas a traducir una página informativa (vendrían siendo anexos, explicaciones y listas de constantes), como por ejemplo Anexo: Límites del sistema de archivos, debes usar la siguiente base:

<div class="main-text">
<h1>Título de la página</h1>
Contenido...
</div>

Plantilla de categorías

Si vas a traducir una categoría (es decir, una página que agrupe funciones, variables o más páginas) como por ejemplo Manejo de archivos, debes enlistar los elementos relacionados de una forma similar a ésta:

<div class="main-text">
<h1>Título de la página</h1>
Contenido...

<ol>
    <li>
    	<h2>Sub-categoría 1</h2>
    	Contenido...

    	<h3>Relacionado</h3>
    	<ul>
    		<li><code>Función_x()</code></li>
    		<li><code>Variable_y</code></li>
    		<li><code>Función_z()</code></li>
    	</ul>

    </li>


    <li>
    	<h2>Sub-categoría 2</h2>
    	Contenido...

    	<h3>Relacionado</h3>
    	<ul>
    		<li>Anexo: Información 1</li>
    		<li>Anexo: Lista de constantes</li>
    	</ul>

    </li>

</ol>
</div>

Plantilla de funciones

Si vas a traducir una función o variable específica, usa la siguiente plantilla:

<div id="name">
	nombre_funcion
</div>

<div id="content">

	<div id="description">
		Descripción de la función...
	</div>

	<h2>Sintaxis</h2> <!--No modifiques este título-->
	<div id="sintax">
		<pre class="gml-syntax">
			nombre_funcion(arg1, arg2, argx);
		</pre>
	</div>

	<h2>Argumentos</h2><!--No modifiques este título-->
	<table id="arguments">
		<tr>
			<th>Argumento</th> <!--No modifiques este texto-->
			<th>Descripción</th> <!--No modifiques este texto-->
		</tr>

		<tr>
			<td>arg1</td>
			<td>Descripción del argumento.</td>
		</tr>

		<tr>
			<td>arg2</td>
			<td>Descripción del argumento.</td>
		</tr>

		<tr>
			<td>argx</td>
			<td>Descripción del argumento.</td>
		</tr>

	</table>

	<h2>Descripción</h2><!--No modifiques este título-->
	<div id="longdescription">
		Aquí describe detalladamente la función.
	</div>

	<h2>Devuelve</h2><!--No modifiques este título-->
	<div id="returns">
		¿Qué tipo de valor devuelve? 
		(Número real, cadena de texto, booleano, arreglo, búfer, puntero, etc.).
	</div>

	<h2>Ejemplo</h2><!--No modifiques este título-->
	<div id="example">
		<pre class="gml-syntax">
///Inserta aquí el código del ejemplo
var a = 4;
show_message(a);
		</pre>

		Aquí explica tu ejemplo...
</div>

</div>

Etiquetas especiales

Si quieres insertar una pieza pequeña de código GML, puedes usar la etiqueta code:

No usen la función <code>show_message("hola!");</code>, es poco óptima.

Si quieres insertar bloques grandes de código GML, puedes usar la etiqueta pre, con la clase CSS gml-syntax:

A continuación un ejemplo de uso:
<pre class="gml-syntax">
var len = 5;
var dir = 30;
var lex = lengthdir_x(len, dir);
var ley = lengthdir_y(len, dir);
</pre>
⚠️ **GitHub.com Fallback** ⚠️