Módulo:Mooc/doc

Este é o script MOOC central para renderizar um item MOOC em uma página wiki.

Funções invocáveis

As seguintes funções são estáticas e, portanto, podem ser invocadas pelas páginas do wiki.

overview

Renderiza a visão geral na página invocadora. A página de visão geral lista todas as lições que o MOOC consiste.

Parâmetros:

• Frame: Objeto do quadro WikiMedia que contém informações sobre a página de invocação.

Retorno:
Representação em string da página de visão geral renderizada.

render

Renderiza um item MOOC na página invocadora. O título da página invocadora é usado para identificar o item a ser renderizado. Assim, você não pode invocar o módulo em páginas não-moco: O título da página deve ser uma subpágina da página MOOC.

Parâmetros:

• Frame: Objeto do quadro WikiMedia que contém informações sobre a página de invocação.

Retorno:

• Representação em string da página de visão geral renderizada.
• Lança um erro se a página invocadora não for um filho da base MOOC.
• Lança um erro se a página invocadora não representar um item MOOC (veja explicação abaixo).

Funções de Instância

As funções a seguir são acessíveis por outros módulos LUA se eles tiverem acesso a uma instância MOOC. Portanto, elas não podem ser invocadas diretamente por páginas wiki.

init

Inicializa o Módulo MOOC. Este método pode ser substituído e é suposto registrar manipuladores de tipos para todos os tipos de itens conhecidos. Se o método for substituído, você sempre pode chamar o método super.

Parâmetros:

• BaseUrl - string que indica o título da base MOOC (a página onde o MOOC está locado).

addTypeHandler

Registra um manipulador de tipo para um tipo de item MOOC.

Parâmetros:

1. TypeHandler - instância do manipulador de tipo a ser registrada.

getBaseUrl

Determina o título da página da base MOOC. Esta implementação padrão considera a página raiz da página wiki de invocação como base MOOC.

Retorno:
Título da página da base MOOC.

getIndexUrl

Determina o título da página do index MOOC padrão.

O índice MOOC padrão está localizado em `/MoocIndex` relativo à base MOOC.

Retorno: Título da página do MOOC index.

getCurrentPath

Obtém o caminho do item MOOC da página wiki invocadora. O caminho do item MOOC é sempre relativo à base MOOC.

Retorno:

• Caminho do item MOOC da página wiki de invocação.
• Nulo ("nil") se a página invocadora não for filha da base MOOC.

getIndex

Recupera o conteúdo simples do texto wiki da página do índice MOOC.

Retorno:

• Texto wiki da página index do MOOC.
• Lança um erro se a recuperação do conteúdo falhar.

renderOverview

Renderiza a visão geral na página invocadora. A página de visão geral lista todas as lições em que o MOOC consiste.

Parâmetros:

1. Frame: Objeto do quadro WikiMedia que contém informações sobre a página de invocação.

Retorno:
Representação em string da página de visão geral renderizada.

renderItem

Renderiza um item MOOC na página invocadora. No momento, uma página só pode renderizar o item que representa (item com o caminho igual ao título da página relativo à base MOOC).

Parâmetros:

1. Frame: Objeto do quadro WikiMedia que contém informações sobre a página de invocação.

Retorno:
Representação em string da página de visão geral renderizada.

• Lança um erro se a página invocadora não for um filho da base MOOC.
• Lança um erro se a página invocadora não representar um item MOOC (veja explicação abaixo).

Funções locais

As funções abaixo são locais e, portanto, não podem ser invocadas por páginas wiki ou outros módulos Lua.

getHandler

Obtém o manipulador de tipos para um determinado tipo de item MOOC. The handler must be registered before. Por exemplo, usando `addTypeHandler`.

Parâmetros:

1. typeIdentifier - String que identifica o tipo do item MOOD que o manipulador precisa.

Retorno:

• Manipulador de template para o tipo de item MOOC especificado,
• Lança um erro se nenhum manipulador de tipo registrado lidar com o tipo de item especificado.