Download as
Browse Code »

Commit 92c26f1bf77fe6ab258f6acc1976c08a88c07dd4

Authored by Carlos Vieira
1 parent f1e3d2a5
Exists in master

Adiciona arquivos para gerar manual

Showing 8 changed files with 414 additions and 0 deletions   Show diff stats
doc/.gitignore 0 → 100644
  Diff comments   View file @92c26f1
... ... @@ -0,0 +1,2 @@
  1 +
  2 +_build/
... ...
doc/LICENSE 0 → 100644
  Diff comments   View file @92c26f1
... ... @@ -0,0 +1,21 @@
  1 +MIT License
  2 +
  3 +Copyright (c) 2018 caduvieira
  4 +
  5 +Permission is hereby granted, free of charge, to any person obtaining a copy
  6 +of this software and associated documentation files (the "Software"), to deal
  7 +in the Software without restriction, including without limitation the rights
  8 +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9 +copies of the Software, and to permit persons to whom the Software is
  10 +furnished to do so, subject to the following conditions:
  11 +
  12 +The above copyright notice and this permission notice shall be included in all
  13 +copies or substantial portions of the Software.
  14 +
  15 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21 +SOFTWARE.
... ...
doc/Makefile 0 → 100644
  Diff comments   View file @92c26f1
... ... @@ -0,0 +1,20 @@
  1 +# Minimal makefile for Sphinx documentation
  2 +#
  3 +
  4 +# You can set these variables from the command line.
  5 +SPHINXOPTS =
  6 +SPHINXBUILD = sphinx-build
  7 +SPHINXPROJ = ManualBarra
  8 +SOURCEDIR = .
  9 +BUILDDIR = _build
  10 +
  11 +# Put it first so that "make" without argument is like "make help".
  12 +help:
  13 + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
  14 +
  15 +.PHONY: help Makefile
  16 +
  17 +# Catch-all target: route all unknown targets to Sphinx using the new
  18 +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
  19 +%: Makefile
  20 + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
... ...
doc/apresentacao.rst 0 → 100644
  Diff comments   View file @92c26f1
... ... @@ -0,0 +1,24 @@
  1 +Apresentação
  2 +============
  3 +
  4 +Sobre o uso e a aplicação da barra de identidade. Para maiores detalhes consulte o `Manual de Identidade Visual do Governo Federal na Internet Regras de aplicação da Barra de Identidade`_.
  5 +
  6 +
  7 +Sobre a barra
  8 +**************
  9 +
  10 +A barra de Identidade Visual do Governo Federal na Internet tem a função de identificar, padronizar e integrar sítios e portais do Governo Federal. A barra também tem a função de proporcionar acesso direto ao Portal Brasil - https://brasil.gov.br, às informações públicas de acordo com a Lei de acesso à informação, aos canais de participação social, ao portal de serviços prestados pelos diversos órgãos - https://servicos.gov.br/, página com toda a legislação brasileira - https://planalto.gov.br/legislacao/ e link para os canais de comunicação do Governo Federal.
  11 +
  12 +Seu uso está normatizado por meio da Instrução Normativa nº 8, de 19 de dezembro de 2014, que pode ser encontrada no `sítio da Secretaria de Comunicação Social da Presidência da República - Secom`_.
  13 +
  14 +Com o objetivo de padronizar a codificação e garantir a aderência às normas da Administração Pública, a nova versão da barra utiliza uma arquitetura integrada e dinâmica, não precisa ser desenvolvida, pois sua funcionalidade encontra-se corretamente configurada e pronta para uso.
  15 +
  16 +A publicação da barra pelos órgãos deverá ser feita de maneira dinâmica por meio da inclusão do código publicado no item Instruções para Uso da Barra no HTML do sítio ou portal.
  17 +
  18 +Após esta primeira publicação, as demais atualizações serão automáticas.
  19 +
  20 +A barra funciona de maneira unificada. Todos os sítios e portais que utilizam esta versão apresentam os conteúdos uniformizados.
  21 +
  22 +.. _`Manual de Identidade Visual do Governo Federal na Internet Regras de aplicação da Barra de Identidade`: http://www.secom.gov.br/orientacoes-gerais/comunicacao-digital/nova-barra-de-identidade-do-governo-federal.pdf
  23 +
  24 +.. _`sítio da Secretaria de Comunicação Social da Presidência da República - Secom`: http://www.secom.gov.br/acesso-a-informacao/institucional/legislacao/arquivos-de-instrucoes-normativas/2014in08-comunicacao-digital.pdf
... ...
doc/conf.py 0 → 100644
  Diff comments   View file @92c26f1
... ... @@ -0,0 +1,181 @@
  1 +# -*- coding: utf-8 -*-
  2 +#
  3 +# Configuration file for the Sphinx documentation builder.
  4 +#
  5 +# This file does only contain a selection of the most common options. For a
  6 +# full list see the documentation:
  7 +# http://www.sphinx-doc.org/en/stable/config
  8 +
  9 +# -- Path setup --------------------------------------------------------------
  10 +
  11 +# If extensions (or modules to document with autodoc) are in another directory,
  12 +# add these directories to sys.path here. If the directory is relative to the
  13 +# documentation root, use os.path.abspath to make it absolute, like shown here.
  14 +#
  15 +# import os
  16 +# import sys
  17 +# sys.path.insert(0, os.path.abspath('.'))
  18 +
  19 +
  20 +# -- Project information -----------------------------------------------------
  21 +
  22 +project = u'Identidade Visual do Governo Federal na Internet'
  23 +copyright = u'2018, Planejamento'
  24 +author = u'Carlos Vieira'
  25 +
  26 +# The short X.Y version
  27 +version = u''
  28 +# The full version, including alpha/beta/rc tags
  29 +release = u''
  30 +
  31 +
  32 +# -- General configuration ---------------------------------------------------
  33 +
  34 +# If your documentation needs a minimal Sphinx version, state it here.
  35 +#
  36 +# needs_sphinx = '1.0'
  37 +
  38 +# Add any Sphinx extension module names here, as strings. They can be
  39 +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  40 +# ones.
  41 +extensions = [
  42 + 'sphinx.ext.autodoc',
  43 + 'sphinx.ext.githubpages',
  44 +]
  45 +
  46 +# Add any paths that contain templates here, relative to this directory.
  47 +templates_path = ['_templates']
  48 +
  49 +# The suffix(es) of source filenames.
  50 +# You can specify multiple suffix as a list of string:
  51 +#
  52 +# source_suffix = ['.rst', '.md']
  53 +source_suffix = '.rst'
  54 +
  55 +# The master toctree document.
  56 +master_doc = 'index'
  57 +
  58 +# The language for content autogenerated by Sphinx. Refer to documentation
  59 +# for a list of supported languages.
  60 +#
  61 +# This is also used if you do content translation via gettext catalogs.
  62 +# Usually you set "language" from the command line for these cases.
  63 +language = u'pt_BR'
  64 +
  65 +# List of patterns, relative to source directory, that match files and
  66 +# directories to ignore when looking for source files.
  67 +# This pattern also affects html_static_path and html_extra_path .
  68 +exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
  69 +
  70 +# The name of the Pygments (syntax highlighting) style to use.
  71 +pygments_style = 'sphinx'
  72 +
  73 +
  74 +# -- Options for HTML output -------------------------------------------------
  75 +
  76 +# The theme to use for HTML and HTML Help pages. See the documentation for
  77 +# a list of builtin themes.
  78 +#
  79 +html_theme = 'sphinx_rtd_theme'
  80 +
  81 +# Theme options are theme-specific and customize the look and feel of a theme
  82 +# further. For a list of options available for each theme, see the
  83 +# documentation.
  84 +#
  85 +# html_theme_options = {}
  86 +
  87 +# Add any paths that contain custom static files (such as style sheets) here,
  88 +# relative to this directory. They are copied after the builtin static files,
  89 +# so a file named "default.css" will overwrite the builtin "default.css".
  90 +html_static_path = ['_static']
  91 +
  92 +# Custom sidebar templates, must be a dictionary that maps document names
  93 +# to template names.
  94 +#
  95 +# The default sidebars (for documents that don't match any pattern) are
  96 +# defined by theme itself. Builtin themes are using these templates by
  97 +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
  98 +# 'searchbox.html']``.
  99 +#
  100 +# html_sidebars = {}
  101 +
  102 +
  103 +# -- Options for HTMLHelp output ---------------------------------------------
  104 +
  105 +# Output file base name for HTML help builder.
  106 +htmlhelp_basename = 'ManualBarra'
  107 +
  108 +
  109 +# -- Options for LaTeX output ------------------------------------------------
  110 +
  111 +latex_elements = {
  112 + # The paper size ('letterpaper' or 'a4paper').
  113 + #
  114 + # 'papersize': 'letterpaper',
  115 +
  116 + # The font size ('10pt', '11pt' or '12pt').
  117 + #
  118 + # 'pointsize': '10pt',
  119 +
  120 + # Additional stuff for the LaTeX preamble.
  121 + #
  122 + # 'preamble': '',
  123 +
  124 + # Latex figure (float) alignment
  125 + #
  126 + # 'figure_align': 'htbp',
  127 +}
  128 +
  129 +# Grouping the document tree into LaTeX files. List of tuples
  130 +# (source start file, target name, title,
  131 +# author, documentclass [howto, manual, or own class]).
  132 +latex_documents = [
  133 + (master_doc, 'ManualBarra.tex', u'Manual de uso da Barra',
  134 + u'servicos.gov.br', 'manual'),
  135 +]
  136 +
  137 +
  138 +# -- Options for manual page output ------------------------------------------
  139 +
  140 +# One entry per manual page. List of tuples
  141 +# (source start file, name, description, authors, manual section).
  142 +man_pages = [
  143 + (master_doc, 'ManualBarra', u'Manual de uso da Barra',
  144 + [author], 1)
  145 +]
  146 +
  147 +
  148 +# -- Options for Texinfo output ----------------------------------------------
  149 +
  150 +# Grouping the document tree into Texinfo files. List of tuples
  151 +# (source start file, target name, title, author,
  152 +# dir menu entry, description, category)
  153 +texinfo_documents = [
  154 + (master_doc, 'ManualBarra', u'Manual de uso da Barra',
  155 + author, 'ManualBarra', 'One line description of project.',
  156 + 'Miscellaneous'),
  157 +]
  158 +
  159 +
  160 +# -- Options for Epub output -------------------------------------------------
  161 +
  162 +# Bibliographic Dublin Core info.
  163 +epub_title = project
  164 +epub_author = author
  165 +epub_publisher = author
  166 +epub_copyright = copyright
  167 +
  168 +# The unique identifier of the text. This can be a ISBN number
  169 +# or the project homepage.
  170 +#
  171 +# epub_identifier = ''
  172 +
  173 +# A unique identification for the text.
  174 +#
  175 +# epub_uid = ''
  176 +
  177 +# A list of files that should not be packed into the epub file.
  178 +epub_exclude_files = ['search.html']
  179 +
  180 +
  181 +# -- Extension configuration -------------------------------------------------
... ...
doc/index.rst 0 → 100644
  Diff comments   View file @92c26f1
... ... @@ -0,0 +1,25 @@
  1 +.. Manual de uso da Barra documentation master file, created by
  2 + sphinx-quickstart on Mon Mar 26 14:58:34 2018.
  3 + You can adapt this file completely to your liking, but it should at least
  4 + contain the root `toctree` directive.
  5 +
  6 +Manual de uso da Barra
  7 +======================
  8 +
  9 +.. toctree::
  10 + :maxdepth: 1
  11 + :caption: Apresentação
  12 +
  13 + apresentacao
  14 +
  15 +.. toctree::
  16 + :maxdepth: 2
  17 + :caption: Instruções
  18 +
  19 + instrucoes
  20 +
  21 +
  22 +Índices
  23 +========
  24 +
  25 +* :ref:`genindex`
... ...
doc/instrucoes.rst 0 → 100644
  Diff comments   View file @92c26f1
... ... @@ -0,0 +1,105 @@
  1 +Habilitando a barra na página
  2 +-----------------------------
  3 +Cole este código após a abertura da tag <body>.
  4 +
  5 +.. code-block:: html
  6 +
  7 + <div id="barra-brasil" style="background:#7F7F7F; height: 20px; padding:0 0 0 10px;display:block;">
  8 + <ul id="menu-barra-temp" style="list-style:none;">
  9 + <li style="display:inline; float:left;padding-right:10px; margin-right:10px; border-right:1px solid #EDEDED">
  10 + <a href="http://brasil.gov.br" style="font-family:sans,sans-serif; text-decoration:none; color:white;">Portal do Governo Brasileiro</a>
  11 + </li>
  12 + <li>
  13 + <a style="font-family:sans,sans-serif; text-decoration:none; color:white;" href="http://epwg.governoeletronico.gov.br/barra/atualize.html">Atualize sua Barra de Governo</a>
  14 + </li>
  15 + </ul>
  16 + </div>
  17 +
  18 +
  19 +.. important::
  20 + A página deve implementar a `recomendação da eMAG 1.5 de fornecer âncoras para ir direto a um bloco de conteúdo`_. O primeiro link da página deve ser o de ir para o conteúdo. `Veja um exemplo de implementação da barra com o uso do primeiro link para ir para o conteúdo`_.
  21 +
  22 +Cole este código ao final antes do fechamento da tag **<body>**. A boa prática orienta que códigos JavaScript que modificam a página no momento do carregamento devem ser declarados ao final do elemento **<body>**.
  23 +
  24 +.. code-block:: html
  25 +
  26 + <script defer="defer" src="//barra.brasil.gov.br/barra.js" type="text/javascript"></script>
  27 +
  28 +.. note::
  29 + Se utilizar em XHTML não é permitido a minificar os atributos. Se for em HTML é possível utilizar somente 'defer' conforme `exemplo feito pelo W3Schools para a tag script`_.
  30 +
  31 +Mantendo o contexto do órgão no Portal de Serviços ao clicar no link 'Serviços' da barra
  32 +----------------------------------------------------------------------------------------
  33 +Para habilitar o parâmentro 'orgao' no link de 'Serviços' cole este código na tag <head>.
  34 +
  35 +.. code-block:: html
  36 +
  37 + <meta property="creator.productor"
  38 + content="http://estruturaorganizacional.dados.gov.br/id/unidade-organizacional/NUMERO">
  39 +
  40 +
  41 +.. important::
  42 + Esse código é específico para cada órgão. Não utilize códigos de outros órgãos. Troque o **NUMERO** pelo número correto do órgão no SIORG. `Acesse o SIORG e procure pelo seu órgão`_.
  43 +
  44 +Habilitando o footer dinâmico na barra
  45 +--------------------------------------
  46 +
  47 +Para o footer dinâmico coloque este código no local do footer e aplique um dos css abaixo conforme seu tema
  48 +
  49 +.. code-block:: html
  50 +
  51 + <div id="footer-brasil"></div>
  52 +
  53 +
  54 +Coloque esse código css se o seu tema for o **verde**:
  55 +
  56 +.. code-block:: css
  57 +
  58 + #footer-brasil {
  59 + background: none repeat scroll 0% 0% #00420c;
  60 + padding: 1em 0px;
  61 + max-width: 100%;
  62 + }
  63 +
  64 +Coloque esse código css se o seu tema for o **amarelo**:
  65 +
  66 +.. code-block:: css
  67 +
  68 + #footer-brasil {
  69 + background: none repeat scroll 0% 0% #2c66ce;
  70 + padding: 1em 0px;
  71 + max-width: 100%;
  72 + }
  73 +
  74 +Coloque esse código css se o seu tema for o **branco** ou o **azul**:
  75 +
  76 +.. code-block:: css
  77 +
  78 + #footer-brasil {
  79 + background: none repeat scroll 0% 0% #0042b1;
  80 + padding: 1em 0px;
  81 + max-width: 100%;
  82 + }
  83 +
  84 +
  85 +Para habilitar/desabilitar o alto contraste na barra
  86 +----------------------------------------------------
  87 +
  88 +Para habilitar o alto contraste da barra e do rodapé habilite a classe 'contraste' no body:
  89 +
  90 +.. code-block:: html
  91 +
  92 + <body class="contraste">
  93 +
  94 +Para desabilitar o alto contraste da barra e do rodapé desabilite a classe 'contraste' no body:
  95 +
  96 +.. code-block:: html
  97 +
  98 + <body class="">
  99 +
  100 +
  101 +
  102 +.. _`Veja um exemplo de implementação da barra com o uso do primeiro link para ir para o conteúdo`: https://github.com/plonegovbr/brasil.gov.temas/commit/8033373ec152d9caa3026107dd999d149a4ba7cf#diff-b7977cf34206f8facf114ac5d6795021L22
  103 +.. _`recomendação da eMAG 1.5 de fornecer âncoras para ir direto a um bloco de conteúdo`: http://emag.governoeletronico.gov.br/#s3.1
  104 +.. _`exemplo feito pelo W3Schools para a tag script`: http://www.w3schools.com/tags/tag_script.asp
  105 +.. _`Acesse o SIORG e procure pelo seu órgão`: http://siorg.planejamento.gov.br/
... ...
doc/make.bat 0 → 100644
  Diff comments   View file @92c26f1
... ... @@ -0,0 +1,36 @@
  1 +@ECHO OFF
  2 +
  3 +pushd %~dp0
  4 +
  5 +REM Command file for Sphinx documentation
  6 +
  7 +if "%SPHINXBUILD%" == "" (
  8 + set SPHINXBUILD=sphinx-build
  9 +)
  10 +set SOURCEDIR=.
  11 +set BUILDDIR=_build
  12 +set SPHINXPROJ=ManualBarra
  13 +
  14 +if "%1" == "" goto help
  15 +
  16 +%SPHINXBUILD% >NUL 2>NUL
  17 +if errorlevel 9009 (
  18 + echo.
  19 + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
  20 + echo.installed, then set the SPHINXBUILD environment variable to point
  21 + echo.to the full path of the 'sphinx-build' executable. Alternatively you
  22 + echo.may add the Sphinx directory to PATH.
  23 + echo.
  24 + echo.If you don't have Sphinx installed, grab it from
  25 + echo.http://sphinx-doc.org/
  26 + exit /b 1
  27 +)
  28 +
  29 +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
  30 +goto end
  31 +
  32 +:help
  33 +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
  34 +
  35 +:end
  36 +popd
... ...