What is the recommended way to present a Help file? [closed] - html

Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 8 years ago.
Improve this question
It seems that anymore I have no clue what is going to happen when I launch the Help of a program. Which makes it all that much more confusing when having to decide how to create a help file for my application.
For example, it might open my web browser to local instance of an html file. It might point to a web-hosted help website. It could load up the Windows Help and Support center. It may load a chm file. It could load up a custom help form with menus, etc.
What is the "correct" way to implement a help?
I like the idea of chm file, but it makes it hard for me to push any updates to users without them updating the application. Same can be said for a local html based help file.
I also like the idea of doing a web hosted help file because I can update it as needed with new information, but what does that mean for users who don't have an active internet connection? For example (in my case, my software will be used equally in a car-mounted laptop with no internet connection and on a desktop computer with an internet connection)
I'm curious to know what is commonly done when creating a help file, and what authoring tools are used, if any.

A solution I have used for the mobile applications, is to have a local html help file which the application renders for help content in a web view. We then had a background mechanism to check against a service for help updates and download the updated HTML and other static content as appropriate. This way you always have a local HTML file which doesn't require a connection, and renders quickly (since there is no download required for viewing).

The most subtle way is providing a Compiled HTML (CHM) help file.
There are many free and paid apps that help create documentation. You could try Rahman CHM Maker or KEL CHM Creator.

Related

Web app for drag and drop, save as PDF and print [closed]

Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 1 year ago.
Improve this question
I've been tasked to make a web app that users can drag and drop images to a container, depending on the size of the image, it needs to be able to snap in to place until the container is full.
I'm only a beginner programmer, I'm not too sure how to even begin (I've been "googling" for the last couple of days). I'm only going to host the app on a local server.
Can someone point me in the right direction?
Would Python be the best bet here?
Is a Web App even a good approach to this? I'm only going with a web app, so users can access through localhost.
There's no data stored (yet). Just saving as pdf and printing.
I'm not sure what other features will be added in the future, but would be good to have future proofing.
Thank you in advance!
Dispite of my comment I'll give you some directions...
I'll upset a bunch of people, but I don't think python and web are a good match...
You should study a client-side framework like react, that has NPM modules to easily drag and drop, and to organize children in containers in smart ways.
The PDF part is tricky, theres a thing call ghostscript that can "printscreen" a html rendered page and make pdfs, or some tool that do the same using a headless browser.
Can be done, but won't be trivial...

How to upload a website without an html files [closed]

Closed. This question needs details or clarity. It is not currently accepting answers.
Want to improve this question? Add details and clarify the problem by editing this post.
Closed 2 years ago.
Improve this question
H!
I have created a website, where all the files are of the type CSS, js, pug, and when I want to publish the site, I need to give an index.html file from which the site will start. The problem is that I do not have such a file.
Does anyone know how to deal with such a problem?
And in addition, I started the site by running it in localhost: 3000 does anyone know how to start it now so that it will work when I upload it.
Thanks in advance to all the helpers.
Your mention of localhost:3000 implies that you have written a website which depends on Node.js for server-side code (at a minimum this will involve the translation of your Pug templates into HTML on demand).
There are two general approaches you can take to solve this problem:
Find hosting which supports your server-side code and deploy your Node.js application to it. (This will not be typical static or shared hosting).
Generate static HTML documents from your application and upload those HTML documents. (The specifics will depend on exactly what your server-side implementation does and will probably be a significant amount of work. Typically if you wanted to take this approach, you would have used a framework designed to output static sites from the outset).
Obviously if you have your server-side code processing user input (such as form submissions) option 2 will not work.

How can learn to make a website(just for practising) without paying for domain and host? [closed]

Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 8 years ago.
Improve this question
I am learning how to make a website and wondering if it's possible to build my own website just for learning purpose without paying for domain and host? In other words, how can I practise making a website in which I can do almost all things like ones I can do with a real website but I don't have to pay anything?
You could simply create an index.html file, code in there, and then open that file in a web browser like chrome.
As simple as that :)
You can use wamp (windows), or mamp (mac), etc, if you're trying to learn PHP.
There are some others software like SQL server management and IIS for ASP.NET website.
But in case of, learning HTML / CSS / JavaScript can be run on your own machin without any needs. (or txt editor maybe)
You can find somes tuto on internet about "learn html css" or "html / css lessons"
I can recommand you this website, which help me a lot to start.
You can install something like XAMPP which will render your website files.
If you are just starting with static HTML, CSS and maybe JavaScript later on the way, just create a folder, named e.g. 'myFirstWebsite', in the home directory of your computer, and put a file called index.html into the folder.
Now start hacking! ;)
You can open the file with any browser and it will work. Even JS, embedded in your .html file or in a separate, referenced .js file will execute.
Things get more complicated when you want to do server related things like working with a blog system like Wordpress or similar. The you have to install a local webserver like Apache, a database, PHP (if you absolutely need to) and so on. All of that is combined into the aforementioned WAMP, LAMP, MAMP ... packages.
A great knowledge resource is the Mozilla Developer Network.

Reading proprietary file type [closed]

Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 7 years ago.
Improve this question
How does one develop a software to read a proprietary file type without having that proprietary software. Something like what the open office folks did with MS Word (.doc) files. Open Office can read .doc files.
That might be easy if the proprietary software has an open source SDK to it, for example Adobe has the Flex open source SDK so it's possible to create flash (.swf) files without having Adobe Flash. But in the case of MS Word, which I believe had no open source SDK, how did the open office guys get it to read it.
Of course I'm using open office just as an example, but my question is general, how could one read a proprietary output file? What's the idea here? I know someone will say reverse engineering, but I don't think reverse engineering the entire software makes sense here (not that I know anything about that field yet) because the goal is not to create software that has the same functionalities. Is there a way to work with the output file only?
Any thoughts on this?
It's an iterative process:
Inspect the stream of raw bytes in the file and make a guess as to what they mean
Write code to verify the guess
See what goes wrong when you try to load the file
Repeat
You'll need a wide variety of test files, a lot of patience and large dollops of insight.
My experience is that it's pretty easy to handle the basics, but that complex file format features can be a pain to handle.
If you are lucky, at least some information on the file for example MS does has information on the doc file.
Other wise it is lot of work. basically you make a simple document save it, then make a small change, save it and compare the two. Eventually you can figure out the format.

What is the best way to generate a sitemap? [closed]

Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 7 years ago.
Improve this question
I need to build a sitemap for my website.
The url will be "www.example.com/mysitemap.html".
I know that there are some tools that generate automatically an XML file that contains the
reachable URLs and also improve the SEO.
So my questions are:
How can I build this HTML page going from the generated XML? Or am I wrong and this kind of HTML page is built manually? If not, how do we integrate the XML and convert it to the website?
Thank you very much.
Regards.
If your site architecture is contained in a database (like a CMS) you can do something like Darkyo suggested.
However there are easier methods. There are many free services which crawl your site and create a sitemap
http://www.xml-sitemaps.com/ or http://sitemapdoc.com/ are some examples but the Internet is full of them. Just google "sitemap creator".
If you want to create your own script there is program called "php sitemap ng" at http://enarion.net/google/phpsitemapng . This can be a real good starting place.
If you run a content based site (like YouTube for example), just write a small script that reads your database and generates an XML file for each URL.
Put it as a cron job once every day/week. You can also ping Google/Yahoo/MSN etc. when your sitemap gets updated so they can pick your new sitemap and index the new URL's.
It really depends of how is programmatically build your website,
if your website is huge and reflects a db schema, the best thing
is to write a friendly url generator and store it to the db.
Thank to this system you'll be able to manage retrieve your sitemap easilly
Select CONCAT("http://mysite.com/article/",article.friendly_url) from article
But as I said it highly depends of your architecture / programming ....
Automatically is very hard. You can help though, by using correct semantics.
This will make Google pick up your site's structure better.
When your website consist of static pages you can create a sitemap yourself. If though it is generated with a database you can do this programmaticly. This won't be easy though if you have no experience.
If you use a CMS like Wordpress or Drupal or ... you probably can generate it with a plugin. Use Google for that!