Search Unity

  1. Welcome to the Unity Forums! Please take the time to read our Code of Conduct to familiarize yourself with the forum rules and how to post constructively.
  2. We have updated the language to the Editor Terms based on feedback from our employees and community. Learn more.
    Dismiss Notice
  3. Join us on November 16th, 2023, between 1 pm and 9 pm CET for Ask the Experts Online on Discord and on Unity Discussions.
    Dismiss Notice

Trying to install the offline documentation

Discussion in 'Documentation' started by MichaelSzczech, Jan 5, 2016.

  1. MichaelSzczech

    MichaelSzczech

    Joined:
    Jan 5, 2016
    Posts:
    1
    Hello, Ive been having an issue combining the offline documentation files. Ive been doing this as an attempt to create one printable IN ORDER pdf file. After downloading the installer and selecting the documentation box i have successfully installed the editor file on my computer. Its contents holds a DocCombiner.exe file which my computer fails to even recognize upon opening it. I need help thank you.
     
  2. feiting

    feiting

    Joined:
    Oct 26, 2012
    Posts:
    33
    That program is probably meant to be run from a CMD prompt, and I doubt it does what you think. There is no documentation on it, I would bet it's the tool they use to create what you already have. Someone wrote a tool awhile ago to make the manual thumb-through-able. Some javascript and CSS edits that let you hit the arrow keys on your keyboard, and if you must use the mouse, they moved the right arrow next to the back arrow, so you can widen your window without having the button super far away. Probably buried in this forum somewhere...

    It may have gone into Core.js and looked something like this:
    but only worked on firefox without Rasmus's input...

    just guessing.
    Code (JavaScript):
    1. /****************************************
    2.   ==== 8. USER ADDED FUNCTIONS
    3. ****************************************/ // Allow arrow keys to navigate
    4.   $(document).keypress( function(e) {
    5.     switch(e.keyCode)
    6.     {
    7.       case 37:
    8.      $(".prev")[0].firstElementChild.click();
    9.       break;
    10.       case 38: //up
    11.           var listElem = $("div[class='breadcrumbs clear']")[0].firstElementChild;
    12.           if( listElem.children.length >= 2)
    13.           {
    14.               listElem.children[listElem.children.length-2].firstElementChild.click();
    15.          }
    16.       break;
    17.      case 39:
    18.      $(".next")[0].firstElementChild.click();
    19.      }
    20.       } );
     
  3. rasmus-unity

    rasmus-unity

    Unity Technologies

    Joined:
    Aug 15, 2014
    Posts:
    1,312
    @feiting, don't think your keyboard navigation ever got into the documentation source. Personally I liked it, but as I remember there was some uncertainty if it would break other stuff. So we left it as a "community-extension" (and I moved to another team in Unity...). But thanks anyways for this input

    @MichaelSzczech, the DocCombiner.exe is not for generating one large documentation file, but used to "merge" documentation for different platforms during installation. You would need to make your own tool which combines the HTML files, if you want this. Write here if you solve it :)

    -Rasmus
     
  4. feiting

    feiting

    Joined:
    Oct 26, 2012
    Posts:
    33
    haha, nice reply (to Mike) Rasmus. I personally don't care for accreditation (I remember you asked me). Just keep it to "felting" I guess. Didn't know there was a community extensions area, I may take a more active role there (I'll find it if it's not buried in git forking).

    If I were to push for anything, it's that darn right-arrow hugging the right side, nobody I've talked to hasn't found that annoying. It should hug the right of the left-arrow.

    Anyway, that was off topic, just glad to see you're still there!
     
  5. rasmus-unity

    rasmus-unity

    Unity Technologies

    Joined:
    Aug 15, 2014
    Posts:
    1,312
    Sorry, we don't have an actual official "community extensions area". Just meant that your solution can be implemented by other users