Files
unison/doc/ns3_html_theme
Peter D. Barnes, Jr 6e5f36a795 doc: (fixes #469) Add license to file.
This is based on the following email exchange with the author of this
file:

From: Konstantin Yagola info@spicebrains.com
Subject: Re: License for Simple Javascript Drop-Down Menu v2.0
Date: November 6, 2021 at 12:50 PM
To: Barnes, Peter D. barnes26@llnl.gov
Hi Peter,

> Please let me know if this is acceptable.

acceptable.

-K.

On 05.11.2021 23:38, Barnes, Peter D. wrote:
> Hello Konstantin,
>
> I apologize but I have led you astray.  Apparently the license I suggested
> is not appropriate for source code.  An appropriate software license would
> be the “modified BSD (3 clause) license”, which is here:
> https://directory.fsf.org/wiki/License:BSD-3-Clause
>
> Please let me know if this is acceptable.
>
> Thanks again for your help in resolving this.
> Peter
>
> On Oct 13, 2021, at 9:15 AM, Konstantin Yagola <info@spicebrains.com> wrote:
>>
>> Hello Barnes,
>>
>> You are right, I'm not familiar with licensing )
>> This is old not complicated script, so you may maintain it based on fair use.
>> If you think "CC BY-SA 4.0” suits best - then ok.
>>
>> -Kind regards,
>> -K Y.
>>
>> On 12.10.2021 1:55, Barnes, Peter D. wrote:
>>> Hello Folks,
>>>
>>> I am one of the maintainers for the ns-3 Simulator project:
>>> https://www.nsnam.org
>>>
>>> It has come to my attention that we are using your Simple Javascript
>>> Drop-Down Menu v2.0, but the use license is not clear.
>>>
>>> Our use is here:
>>> https://gitlab.com/nsnam/ns-3-dev/-/blob/master/doc/ns3_html_theme/static/drop-down-menu.js
>>>
>>> As requested on your page, we have given attribution to your page.
>>> However, since the javascript is copyrighted, there should be a
>>> statement of licensing terms, or reference to a standard license.
>>>
>>> Could you please advise us of the license terms?  If you are not familiar
>>>  with licensing, perhaps you would consider one of the well-known Creative
>>> Commons licenses?  They have a short form which can help you pick one
>>> to meet your needs:
>>> https://chooser-beta.creativecommons.org
>>>
>>> Given  your encouraging statement
>>>
>>>> That's it! All you have to do now is add some hover styles and make it
>>>> your own. Enjoy!
>>>> If you want to use this script on your page, please place link to
>>>> http://javascript-array.com at one of your pages.
>>>
>>> might I suggest "CC BY-SA 4.0”.
>>>
>>> Please let me know if that is acceptable, or if you choose another license,
>>> and I will update our file to reflect that.
>>>
>>> Thanks,
>>> Peter
2021-11-11 18:03:46 +00:00
..
2012-07-30 17:27:24 -07:00

.. ns3-theme documentation master file, created by
   sphinx-quickstart on Fri Jun 15 12:53:37 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


The files in this directory customize the Doxygen and Sphinx
layout and rendering to give a common look.


Design
------

The basic color scheme is taken from the ns3 homepage, http://www.nsnam.org/

Since Sphinx provides more flexible layout and configuration control,
the Doxygen layout and images are used as the basis.

The top bar design is derived from Doxygen's default when a logo,
project name and description are given in the Doxygen configuration file.
The files ``layout.html`` and ``ns3_doxy_header.html`` should kept in sync.


Sphinx Files
------------

``layout.html`` (:ref:`static filename <sphinx-static-filenames>`)
    Augments the default page layout, including the top bar.

``theme.conf`` (:ref:`static filename <sphinx-static-filenames>`)
    Configuration parameters for ``layout.html`` and ``default.css_t``.

``static/bc_s.png``
    Angle bracket in Sphinx relbar, taken from the Doxygen html output.

``static/default.css_t`` (:ref:`static filename <sphinx-static-filenames>`)
    Default Sphinx CSS template, copied from the default theme.

``static/nav_f.png``
    Background image for headings, taken from the Doxygen html output.

``static/sidebar.js`` (:ref:`static filename <sphinx-static-filenames>`)
    Sidebar script, copied from the default theme.

``static/tab_b.png``
    Background image for the Sphinx relbar, taken from the Doxygen html output.

.. _sphinx-static-filenames:
.. note:: **Static Filenames**

  Sphinx uses hard-coded file  names (and the ``static`` directory name).
  The files referenced above can't be renamed.


Doxygen Files
-------------

``ns3_doxy_footer.html``
    Defines the page footer.

``ns3_doxy_header.html``
    Defines the page header, including the top bar.

``static/doxygen.css``
    Default Doxygen CSS file, obtained by the ``doxygen -w html ...``
    command.

Shared Files
------------

``README.rst``
    This file, not used by Doxygen or Sphinx.

``static/bar-top.png``
    Background image for the top bar, resized from the ns-3 homepage.

``static/favicon.ico``
    Browser location bar favicon, referenced in ``layout.html`` and
    ``ns3_doxy_header.html``, taken from the ns-3 homepage.

``static/ns-3-inverted-notext-small.png``
    Logo used in the top bar, taken from the ns-3 media kit.

``static/ns3_stylesheet.css``
    Style customizations for both Doxygen and Sphinx.