elua/doc/docdata.lua

-- The eLua documentation structure (main menu) is defined here.

--[[
The menu is defined by an array of { name, link, submenu, title } arrays

'name' can be another array. Names must be the same for all languages, in the same order 
as defined in the "languages" from 'buildall.lua'. If 'name' is a string instead
of a table, it will be used in all languages.

'link' is the relative link corresponding to the menu entry.

'submenu' is optional. If specified, it is an array of arrays, just like the main
menu.

'title' is the title of the HTML page associated with the menu entry (specified as 
an array in different languages or as a string, just like 'name'). If not given, 
it's the same as 'name'.

If 'link' is nil, the entry defines a menu separator.
If 'name' is nil, the entry defines a "hidden menu item": they are part of the template to HTML
generation process, but they don't appear in the menu. These entries NEED A LINK
AND TITLE FIELDS! See the definition of 'forum.html' below for an example of such item.
--]]

local menu =
{
  -- "eLua project" (menu separator)
 --[[ { { "eLua project", "Projeto eLua" } },

  -- "Overview"
  { { "Overview", "Apresentação" }, "overview.html", 
    {
      { { "What is eLua?", "O que é eLua ?" }, "overview.html#whatis" },
      { { "Features", "Características" }, "overview.html#features" },
      { { "Audience", "Público Alvo" }, "overview.html#audience" },
      { { "Authors", "Autores" }, "overview.html#authors" },
      { { "Contacts","Contatos" }, "overview.html#contacts" },
      { { "License", "Licença" },"overview.html#license" },
    }
  },

  -- "Community"
  { { "Community", "Comunidade" }, "comunity.html", 
    {
      { { "Discussion Lists", "Listas de Discussão" }, "comunity.html#lists" },
      { "Forums", "comunity.html#forums" },
      { "IRC", "comunity.html#irc" },
      { "Twitter", "comunity.html#twitter" }, 
      { "Wiki", "comunity.html#userswiki" },      
      { { "Credits", "Créditos" }, "comunity.html#credits" },
      { "Donations", "comunity.html#donations" },
      { nil, "forum.html", nil, "Forum" } -- "hidden" entry (doesn't appear in the menu)
    }
  },

  -- News
  { { "News", "Notícias" }, "news.html" },
  
  -- Media
  { "Media", "media.html" },  

  -- Wiki
  { "eLua Wiki", "http://wiki.eluaproject.net" },

  -- Web builder
  { "eLua Web builder", "http://builder.eluaproject.net" },

  -- Tracker
  { "eLua bug tracker", "http://tracker.eluaproject.net" },

  -- "Status"
  { "Status", "status.html", 
    {
      { { "Supported platforms", "Plataformas Suportadas" }, "status.html" },
      { "System timer support", "status.html#systmr" },
      { { "Modules per platform table", "Módulos por plataforma" }, "status.html#plat_modules" },
      { { "Modules overview status", "Visão geral dos módulos" }, "status.html#gen_modules" },
      { { "Roadmap", "Planejamento Futuro" }, "status.html#roadmap" }
    }
  },

 -- "Using eLua" -- Menu Separator
  { { "Using eLua", "Usando eLua"}, nil },      

  { "Downloads", "downloads.html",    -- ### How come it opens downloads.html without specifying here ? :) Nice but unclear.
    {
      { { "Binaries", "Binários" }, "downloads.html#binaries" },
      { { "Source code", "Código Fonte" }, "downloads.html#source", 
        {
          { { "Official releases", "Versões Oficiais" }, "downloads.html#official" },
          { "Bleeding edge (SVN)", "downloads.html#svnpublic" },
          { { "Developers", "Desenvolvedores" }, "downloads.html#svndev" },
        }
      },
      { { "Old versions", "Versões Anteriores" }, "dl_old.html", 
        {
          { "0.7", "dl_old.html#v070" },
          { "0.6", "dl_old.html#v060" },
          { "0.5", "dl_old.html#v050" },
          { "0.4.1", "dl_old.html#v041" },
          { "0.4", "dl_old.html#v04" },
          { "0.3", "dl_old.html#v03" },
          { "0.2", "dl_old.html#v02" },
          { "0.1", "dl_old.html#v01" },
          { { "Version history", "Histórico das Versões" }, "versionhistory.html" },
        }
      },
    },
  },
  --]]
  { { "Introduction"}, "index.html"},

  -- "Status"
  { {"Status"}, "status.html", 
    {
      { { "Supported platforms", "Plataformas Suportadas" }, "status.html" },
      { { "Modules per platform table", "Módulos por plataforma" }, "status.html#plat_modules" },
      { { "Modules overview status", "Visão geral dos módulos" }, "status.html#gen_modules" },
      { { "Roadmap", "Planejamento Futuro" }, "status.html#roadmap" }
    },
  },
  { { "Generic info", "Doc Genérica" }, "using.html", 
    {
      { { "Using eLua", "Usando eLua" }, "using.html", 
        {
          { { "Over UART", "Console via UART" }, "using.html#uart" },
          { { "Over TCP/IP", "Console via TCP/IP" }, "using.html#tcpip" },
          { { "On PC", "Num PC" }, "using.html#pc" },
          { { "The shell", "O Shell" }, "using.html#shell" },
          { "Linenoise", "linenoise.html" },
          { "Cross-compiling", "using.html#cross" },
          { "LuaRPC", "using.html#rpc" },
          { "The serial multiplexer", "sermux.html" },
          { nil, "simple_shell.html", nil, "Simple shell" },
          { nil, "advanced_shell.html", nil, "Advanced shell" },
        },
      },
      { { "Code examples", "Exemplos de Código" }, "examples.html" },
      { { "FAQ", "Perguntas Frequentes (FAQ)" }, "faq.html" },     
      { "eLua file systems", "filesystems.html",
        {
          { { "Read-Only FS in MCU Flash", "O ROM File System em Flash" }, "arch_romfs.html" },
          { "R/W FAT FS in SD/MMC Cards", "fatfs.html" },
          { "Remote file system (RFS)", "arch_rfs.html" },
          { "Write once file system (WOFS)", "arch_wofs.html" },
        }
      },
      { "eLua interrupt handlers", "inthandlers.html",
        {
          { "In Lua", "inthandlers.html" },
          { "In C", "inthandlers.html#cints" },
        }
      },
      { { "Building eLua", "Build de eLua" }, "building.html",
        {
          { "Configuring the image", "configurator.html",
            {
              { "CPU", "configurator.html#config_cpu" },
              { "Components", "configurator.html#config_components" },
              { "Configuration", "configurator.html#config_config" },
              { "Modules", "configurator.html#config_modules" },
              { "Headers", "configurator.html#config_headers" },
              { "Macros", "configurator.html#config_macros" },
              { "CPU constants", "configurator.html#config_cpuconstants" },
              { "Build options", "configurator.html#config_build" },
              { "Customizing", "configurator.html#config_customize" },
            },
          },
          { "Building eLua in Linux", "building_unix.html" },
          { "Building eLua in Windows", "building_win.html" },
          { "Building eLua in Macintosh OS/X", "building_macos.html" },
        },  
      },
    },
  }, 
--[[  { { "Platform info", "Doc Específica" }, "installing.html", 
    {
      { "AT91SAM7x", "installing_at91sam7x.html" },
      { "AVR32", "installing_avr32.html" },
      { "i386", "installing_i386.html" },
      { "LM3S", "installing_lm3s.html" },
      { "LPC2888", "installing_lpc2888.html" },
      { "STR7", "installing_str7.html" },
      { "STR9", "installing_str9.html" },
      { "STM32", "installing_stm32.html" },
      { "LPC2468", "installing_lpc2468.html" }
    },
  },--]]
          
  
  -- "eLua internals" (menu separator)
  { { "eLua internals" },"",
    { 
      { -- "Overview"      
        { "Overview", "Visão Geral" }, "arch_overview.html", 
        {
          { { "eLua's Architecture", "Arquitetura de eLua" }, "arch_overview.html#structure" },
          { { "Common code", "Código Básico" }, "arch_overview.html#common" },
          { { "Interface architecture", "Interfaceamento" }, "arch_overview.html#platform" },
          { { "Booting eLua", "O Boot de eLua" }, "arch_overview.html#boot" },
          { { "Platforms and ports", "Portabilização" }, "arch_overview.html#platforms" },
          { { "Adding a new port", "Portando eLua" }, "arch_newport.html" },
          { "Implementing interrupts", "arch_ints.html",
            {
              { "Interrupt list", "arch_ints.html#intlist" }
            }
          }
        }
      },
       -- Platform interface (automatically generated)
      { { "Platform interface", "Interfaceamento" }, "arch_platform.html", "arch_platform" },

      -- Other WRITE THE arch_platform_other.html file
      { { "More information", "Informações Adicionais" }, "#", 
        {
          { { "Consoles and terminals", "Consoles e Terminais" }, "arch_con_term.html" },
          { { "TCP/IP in eLua", "TCP/IP em eLua" }, "arch_tcpip.html" },
          { { "LTR (Lua Tiny RAM) in eLua", "LTR (Lua Tiny RAM) em eLua" }, "arch_ltr.html" },
          { "EGC (Emergency GC) in eLua", "elua_egc.html" },
          { { "Booting on a PC", "Bootando num PC" }, "tut_bootpc.html" },
          { { "Booting from a PenDrive", "Bootando de um Pen-Drive" }, "tut_bootstick.html" },
          { { "Using OpenOCD", "Usando OpenOCD" }, "tut_openocd.html" },
          { { "eLua toolchains", "Toolchains para eLua" }, "toolchains.html" },
          { { "Building toolchains", "Build de Toolchains" }, "tchainbuild.html",
            {
              { "ARM7 and ARM9", "tc_arm.html" },
              { "ARM Cortex-M3", "tc_cortex.html" },
              { "i386", "tc_386.html" }
            },
          },
          { { "eLua coding style", "Regras de Codificação" }, "arch_coding.html" },
        }
      },
    }
  },
  
  {  -- "Reference manual" (menu separator)
    { "Reference Manual", "Manual de Referência" },"",
    {
      -- "Generic modules" (automatically generated)
      { { "Generic modules", "Módulos Genéricos" }, "refman_gen.html", "refman_gen" },

      -- "Platform modules" (automatically generated)
      { { "Platform modules", "Módulos Específicos" }, "refman_dep.html", 
        {
           { "lm3s", "modules_lm3s.html", "refman_ps_lm3s" },
           { "str9", "modules_str9.html", "refman_ps_str9" },
           { "stm32", "modules_stm32.html", "refman_ps_stm32" },
           { "stm32f4", "modules_stm32f4.html", "refman_ps_stm32f4" },
           { "mbed", "modules_mbed.html", "refman_ps_mbed" },
           { "mizar32", "modules_mizar32.html", "refman_ps_mizar32" },
        }
      }
    }
  }

}
-- Translations for different strings needed by the generator
-- The order of languages is the same as the one defines in the languages array 
-- defined at the beginning of buildall.lua
local translations = 
{
  { "Overview", "Apresentação" },
  { "Data structures", "Estrutura" },
  { "Functions", "Funções" },
  { "eLua - Embedded Lua", "eLua - Embedded Lua" },
  { "Search", "Pesquisar" },
  { "Language", "Idioma" }
}

-- The "fixed part" are the files/directory that must be present in our final
-- HTML documentation distribution. Directories end with a "/", files don't.
local fixed = 
{
  "images/",
  "js/",
  "css/",
  "index.html"
  
}

-- Return our whole data defined above
return menu, translations, fixed