This document presents a start up tutorial to guide new Ximdex users to create, edit and publish documents in Ximdex 3.0.

In order to be able to start creating documents, it is assumed that at least a project, a server (with defined sinchronization details) and a section were created. It is also assumed that transformation and view templates were added to the project and that at least a language and a channel are available.

1. Select the "Projects" ("Proyectos") tab located on the left, choose one of the previously added projects and click its bullet icon to spread it out (or by double clicking).
2. Select its "ximDOC" folder and expand its action menu by clicking the arrow which appears when the mouse pointer is over the node.
3. Select the "Add new XML" ("Añadir nuevo XML") action to create a new document.
4. Fill the form fields wich appears in the work area tab (on the right):
   1. Filename ("Nombre del archivo"): Name shown on the Ximdex tree, and which will define a publication rute if the node type is defined as publishable and it has a file system representation.
   2. Document type ("Tipo del documento"): Pull down menu where the templates (PVD and RNG) which define the elements to be used in the document are defined.
   3. Languages ("Idiomas"): Tick the language(s) to use. If more than one is selected, one of them can be defined as master, and the rest will inherit its content.
   4. Channels ("Canales"): Tick the publication channel(s) to use.
   5. Click the "Create" ("Crear") button.

• Note: Documents will be edited by ximEditor or Xedit according to the chosen template type (PVD or RNG respectively)

Depending on which template type is selected when a XML document is created, the document update will be done with the ximEditor (PVD) or Xedit (RNG).

1. Select the "Projects" ("Proyectos") tab located on the left, choose one of the previously added projects and click its bullet icon to spread it out (or by double clicking).
2. Select the document idiomatic version to update by clicking it and expand its action menu by clicking the arrow which appears when the mouse pointer is over the node.
3. Select the "Edit XML" ("Editar XML") action to edit the document.

• If the document was created using PVD, the ximEditor will be shown. The opened document will include the elements defined in the PVD (the template can be updated, modifying, adding or deleting its elements).
  1. Adding a generic element: Rightclick the arrow icon that appears on the left of the element which will be just over the new one, and select the wanted one from the list.
     • The elements can have properties, such as tables (columns and rows, style, width, sum up, header,...), images (url, link, reference, align, alt text, width, height, ...), ...
  2. Adding a HTML file: Rightclick the arrow icon that appears on the left of the element which will be just over the new one, and select the wanted one from the list. Once the element appears in the editor, double click the text field and select from the shown tree the wanted HTML element located in the ximCLUDE folder.
  3. Adding a ximLET: Rightclick the arrow icon that appears on the left of the element which will be just over the new one, and select the wanted one from the list. Once the element appears in the editor, double click will show a tree where the ximLET can be picked up.
  4. Adding a ximLINK: Select the text to link and press the "Insert link" ("Insertar link") button , located in the top area. Select then the wanted ximLINK and define its properties.
  5. Defining a new style to elements: Select the element to re-define and click the "Insert style" ("Insertar estilo") button , located in the top area. All the available options will be shown, ready to be re-defined.
  6. Deleting an element: Rightclick the arrow icon that appears on the left of the element to delete and select the "Delete" ("Borrar") action.
  7. Undoing a change: Click the "Undo" ("Deshacer") button , located in the top area.
  8. Re-doing a change: Click the "Re-do" ("Rehacer") button , located in the top area.
  9. Sorting elements: Select the element to move, and click the "Move up" ("Subir") or "Move down" ("Bajar") button. It is also available in the menu shown by rightclicking.
• If the document was created using RNG, the Xedit will be shown -> Xedit quick guide is available here

• Using ximEditor (PVD)
  1. Making wanted changes.
  2. Click the "Save" ("Guardar") button , located in the top area.
• Using Xedit (RNG) -> Xedit quick guide is available here

• Defining publication server details:
  A previously created publication server assumed. To do so:
  1. Select the "Projects" ("Proyectos") tab located on the left, choose one of the previously added projects and click its bullet icon to spread it out (or by double clicking).
  2. Select the server by clicking it and expand its action menu by clicking the arrow which appears when the mouse pointer is over the node.
  3. Select the "Modify synchronization data" ("Modificar datos de sincronización") action.
  4. In the tab, select the option "Create a new server" ("Crear un nuevo servidor") in the pulldown menu labeled as "Server" ("Servidor").
  5. Fill out the corresponding form with the server properties:
     • Protocol ("Protocolo"): Choose between:
       • Secure transfer protocol (SSH) ("Protocolo seguro de transferencia (SSH)"): Publication destiny is defined in other machine and SSH connection protocol will be used.
         • Remote URL ("URL Remota"): Project publication url root.
         • Remote address ("Dirección Remota"): Remote machine IP or name where the publication will be carried out.
         • Remote port ("Puerto Remoto"): Conection port to the remote machine where the publication will be carried out.
         • Remote directory ("Directorio Remoto"): Folder located in the remote publication machine where the documents will be copied.
         • Remote user ("Usuario Remoto"): User to connect the remote machine to copy the documents.
         • Paswword ("Contraseña"): Password to connect to the remote machine to copy the documents.
         • Repeat password ("Repetir contraseña"): Repeat typed password.
         • Description ("Descripción"): Name to identify the server.
       • Local synchronization ("Sincronización local"): Publication destiny is defined in the same machine where Ximdex is installed.
         • URL ("URL"): URL where published document will be accesible. I.e., for a preview server: "http:/ /<ip_or_domainName>/<XimdexInstanceName>/data/preview"
         • Directory ("Directorio"): Physical directory there the documents will be published. I.e., for the mentioned preview server: "\/var/www/html/<nombreInstancia>/data/previos"
         • Description ("Descripción"): Name to identify the server.
       • FTP Synchronization ("Sincronización por FTP"): Publication destiny is defined in other machine and FTP connection protocol will be used.
         • Fields to fill out are the same than "SSH synchronization"
  6. Select the channel(s) by means of which documents will be published by ticking it (them).
  7. Click "Update" ("Actualizar") button to save changes.

• Publishing a document from its action menu:
  1. Select the "Projects" ("Proyectos") tab located on the left, choose one of the previously added projects and click its bullet icon to spread it out (or by double clicking).
  2. Select the document idiomatic version to publish by clicking it and expand its action menu by clicking the arrow which appears when the mouse pointer is over the node. Note that ximDOCs are located in the ximDOC folder; ximNEWS news are located in a news folder.
  3. Select the "Get next state" ("Pasar a estado siguiente") action to publish the document. Then, fill the form:
     • Publication period ("Período de publicación"): It defines between which dates the document will be available/published in the publication server destiny. It will be specified by a Start date and a End date. If there is not an end date defined, the document will be available indefinitely.
     • Notifications ("Notificaciones"): It will define which users will receive an email with the publication sending information.
       • Send notifications ("Enviar notificaciones"): Tick this checkbox to send notifications.
       • Group ("Grupo"): Select the group to notify.
       • Users ("Usuarios"): Tick the users of this group to notify.
       • Comments ("Comentarios"): Type the message to send.
  4. Click the "Publish" ("Publicar") button.
• Publishing from Xedit -> Xedit quick guide is available here
• Publishing from text editor
  1. Click the "Save and publish" ("Guardar y publicar") button.