精华内容
下载资源
问答
  • 前段时间对框架做了点改动,要更新文档,最后更新目录时,发现乱了,文档结构图乱了,目录当然也就随着乱了...Word文档结构图内容“越界”问题    这篇文章中说,Word 2003中已经成功解决了这个问题。我深不以为然
        前段时间对框架做了点改动,要更新文档,最后更新目录时,发现乱了,文档结构图乱了,目录当然也就随着乱了,非标题的,出现在文档结构图中。真想大骂,这是多么垃圾的软件!骂解决不了问题,Google了一把,没找到什么解决方案,吃完午饭,回来接着Google,找了了一篇解决方案:
    

    Word文档结构图内容“越界”问题

     

        这篇文章中说,Word 2003中已经成功解决了这个问题。我深不以为然。看到下面的宏,就试试吧!

     

    工具==>宏==>宏(Alt + F6),把下面代码拷进去:

     

    Java代码  收藏代码
    1. Sub ReSetOutline()  
    2. Dim myPara As Paragraph  
    3. For Each myPara In ActiveDocument.Paragraphs  
    4. myPara.OutlineLevel = myPara.style.ParagraphFormat.OutlineLevel  
    5. Next myPara  
    6. End Sub  

     

     

        然后,点上面的运行,要过个好几秒钟的样子才能运行完,回去看看,好了。。。


    展开全文
  • 能够使用php artisan serve 方式运行laravel框架 能够使用composer方式部署laravel框架项目 #composer create-project laravel/...能够解释laravel框架中的主要目录结构 App目录:app 目录包含了应用的核心...
    1. 能够使用php artisan serve 方式运行laravel框架

     

     

    1. 能够使用composer方式部署laravel框架项目

     #composer  create-project  laravel/laravel  --prefer-dist  ./需要创建的路径(确保为空)

     

     

    1. 能够解释laravel框架中的主要目录结构
      1. App目录:app 目录包含了应用的核心代码,此外你为应用编写的代码绝大多数也会放到这里;
      2. Bootstrap目录:bootstrap 目录包含了少许文件,用于框架的启动和自动载入配置,还有一个 cache文件夹用于包含框架为提升性能所生成的文件,如路由和服务缓存文件;
      3. Config目录:config 目录包含了应用所有的配置文件,建议通读一遍这些配置文件以便熟悉所有配置项;
      4. Database目录:database 目录包含了数据迁移及填充文件,如果你喜欢的话还可以将其作为 SQLite 数据库存放目录;
      5. Public目录:public 目录包含了入口文件 index.php 和前端资源文件(图片、JavaScript、CSS等);
      6. Resources目录:resources目录包含了视图文件及原生资源文件(LESS、SASS、CoffeeScript),以及本地化语言文件;
      7. Routes目录:routes目录包含了应用的所有路由定义。Laravel默认提供了三个路由文件:web.php、api.php和console.php。 
        (1):web.php 文件包含的路由都会应用web中间件组,具备Session、CSRF防护以及Cookie加密功能,如果应用无需提供无状态的、RESTful风格的API,所有路由都会定义在web.php文件。 
        (2):api.php 文件包含的路由应用了api中间件组,具备频率限制功能,这些路由是无状态的,所以请求通过这些路由进入应用需要通过token进行认证并且不能访问Session状态。 
        (3):console.php 文件用于定义所有基于闭包的控制台命令,每个闭包都被绑定到一个控制台命令并且允许与命令行IO方法进行交互,尽管这个文件并不定义HTTP路由,但是它定义了基于控制台的应用入口(路由)。
      8. Storage目录 
        (1):storage 目录包含了编译过的Blade模板、基于文件的session、文件缓存,以及其它由框架生成的文件,该目录被细分为成app、framework和logs子目录,app目录用于存放应用要使用的文件,framework目录用于存放框架生成的文件和缓存,最后,logs目录包含应用的日志文件; 
        (2):storage/app/public 目录用于存储用户生成的文件,比如可以被公开访问的用户头像,要达到被访问的目的,你还需要在public目录下生成一个软连接 storage 指向这个目录。你可以通过 php artisan storage:link 命令生成这个软链接。
      9. Tests目录:tests 目录包含自动化测试,其中已经提供了一个开箱即用的PHPUnit示例;每一个测试类都要以 Test 开头,你可以通过 phpunit 或 php vendor/bin/phpunit 命令来运行测试。
      10. Vendor目录:vendor目录包含所有Composer依赖。

     

    1. 能够说出laravel框架中的控制器所在的目录

    D:    /laravel/App/Http/Controllers

    1. 能够使用命令行创建自定义控制器

    #php artisan make:controller 控制器名(大驼峰)Controller

    控制器也可以分目录管理,如:要创建Admin/TestController,则指令应该写成

    #php artisan make:controller Admin/TestController

     

    1. 能够说出laravel框架中定义路由的文件的名称

    Routes/web.php

     

    1. 能够说出laravel框架中的get,post两种基础路由

    Get:表示匹配请求类型为get的请求

      <?php

      //基本路由的get请求

      Route::get('get_base', function(){

          return 'get request base';

      });

     

    Post:表示匹配请求类型为post的请求

    <?php

      //基本路由的post请求

       Route::post('post_base', function(){

         return 'post request base';

      });

    1. 能够说出使用路由群组进行模块的划分

    Route::group(公共属性键值数组,回调函数),回调函数中放的剔除公共属性之后的路由

    ①直接像使用DB门面一样的操作方式:以调用静态方法为主的形式,该形式下模型不

    需要实例化,例如: Member:get() 等价于DB::table( 'member' )->get();

    ②实例化模型然后再去使用模型类(普通)

    例如: $model = new Member();$model -> get();

     

    1. 能够说出laravel框架中控制器文件的命名规则

    大驼峰Controller.php

    展开全文
  • 数据库结构文档

    千次阅读 2004-12-20 18:23:00
    文档的类型在ER/Studio5.5.2中有WORD和HTML两种格式,其中的WORD格式可以定制文档的格式和内容,而HTML格式随没有提供定制功能,但其提供的框架结构对我们查询数据库结构是非常方便的。操作过程:1. 直接从Toos...

        实在是失误,ER/Studio提供了导出数据库结构文档的功能,到今天才发现,使用简述如下。文档的类型在ER/Studio5.5.2中有WORDHTML两种格式,其中的WORD格式可以定制文档的格式和内容,而HTML格式随没有提供定制功能,但其提供的框架结构对我们查询数据库结构是非常方便的。<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

    操作过程:

    1.  直接从Toos菜单中选择Reports,在此子菜单下有两个选项,分别对应WORD格式和HTML格式;

    2.  选择WORD格式,在弹出的对话框中选择需要显示的数据库结构信息,这里提供了非常详细的信息,肯定能满足一般的需要,接下去就比较简单了,此处不提;

    3.  如果选择HTML格式生成文档,在弹出的对话框中,选择目标目录和文档的一些标题信息即可,生成的HTML文档可以用FAR做成一个CHM文件,这样维护和查询数据库就方便多了。

    展开全文
  • 前后端分离的工作模式于今...1. word文档模板 2. 第三方平台,类如postman、showdoc等 3. 框架内单独自定义一套绑定路由的结构,再解析成html页面 4. 在框架内每个路由的方法的注释块里按照规则写注释,再解析生...

    前后端分离的工作模式于今是非常流行了,前后端工作的对接,就离开不了API文档的辅助。

     

    根据自己以往的工作经历,以及了解的一些资讯,API文档的建立,无非以下几种方式:

    1. word文档模板

    2. 第三方平台,类如postman、showdoc等

    3. 框架内单独自定义一套绑定路由的结构,再解析成html页面

    4. 在框架内每个路由的方法的注释块里按照规则写注释,再解析生成api文档

    5. 框架内直接编辑markdown文件,再转换成html页面

     

    根据自己的使用心得,发表一下个人看法。

    1.word文档模板:

    这是在第一家公司--富士康科技集团--接触到的,就是公司准备好了一个API文档的模板,每个api对应一个表格,在表格里填上对应的路径(path),调用方式(method)、请求参数,返回数据结构等信息。对于刚开始新增api是ok的,当时测试工作和后端正好在不同城市,api文档可以起到很好的沟通作用。但对于后期维护,总要完善了一个接口,就要对应的去word文档里查找并修改,一旦后端没有或忘记更新了,随着时间过着越久,反而后面越容易把自己带到坑里去。

     

    优点:前期工作少,拿个模板就可以开写了。

    缺点:更新接口不是很方便。

     

    2.第三方平台:

    工作经历中有一家用到,无非就是把api信息录入到第三方平台,本人很是反感。尤其是需要像form表单一样一个个栏位填写,一个个接口的添加,简直是作践后端的时间价值。维护?简直是更乱,因为第三方平台需要登录账号,每多一小步,人发懒的概率就越大,时间久了,api文档不同步的概率和范围就更大更广。

     

    工作中现在我一直用postman测试接口,所以postman是必用的工具。至于用它写api文档是否支持又是否方便,本人没有接触过,就不发表看法了。

    showDoc是编辑markdown方式,对于添加API接口,撰写体验还是很不错的。但接口信息像postman一样一条条分开的,查找浏览不方便,维护一般首先就是要查找,所以维护体验也感觉很不好。所以以往有的公司,项目涉及到成员多批变迁时,就有那种同一个功能出现几个不同的api。因为新增接口信息可以避免去了解去确认此功能接口之前是否已经撰写过,人都有惰性,就干脆直接新增了接口文档记录,结果就自然导致同样接口的文档记录有两三条,文档就慢慢失去了原本的价值:辅助新员工快速了解功能和开展工作。

     

    那什么时候考虑第三方平台呢?

    有的第三方平台实现了接口功能实时监控及安全防护,就是有受到攻击或者接口挂掉的情况时,可以给你手机发短信通知你。如果你非常需要这个,那你就用吧。

     

    优点:前期工作少,有可能带有接口安全防护和实时监控,避免因为接口挂掉带来利益损失。

    缺点:不仅多了一步登录操作,而且大多产品设计的页面体验不好,不利于快速新增及更新文档,管理不好的话,容易失去文档的本身价值。

     

    3.自定义绑定路由的结构:

    这是我自己起的名字,可能不太准确。

    大体实现方式就是,接口写好了并定好了路由,就在另外一个php文件针对每一条路由用php语言来定义好一个api文档所需要的信息。

    例如如下:

    $app->route("user/getlist")
    ->request(
            array(
                'page' => '1 //第几页',
                'page_size' => '10 //每页数据条数'
            )
        )
        ->method('post')
        ->response(
            array(
                'data' => array(
                    'total_count' => '199 //总记录条数',
                    'list' => array(
                        'username' => 'coderzhai //姓名',
                        'gender' => '1 //1-男 2-女'
                    )
                )
            )
        )

    然后自己再根据上述结构解析出对应数据展示在页面里。

     

    优点:跟后端代码一起,文档更新及维护更方便。文档按功能划分、按区域划分、按版本划分、增加用户权限控制等实现比较方便。

    缺点:由于以上代码是用php语言编写的,一旦遇上哪里少了括号或是逗号等php语法错误,就会造成文档页面无法浏览。还需要费时间的去找到问题的所在并及时修复它。接口路由不适宜用resource组合的,因为具体对应增删查改哪几个接口不好确定。

     

    4.利用方法的注释块生成api文档

    这种方式是了解apidoc时了解到的,就是按照规定的规则在接口方法的注释块里备注信息,类如如下:

    /**
    * @api {get} /user/:id Request User information
    * @apiName GetUser
    * @apiGroup User
    *
    * @apiParam {Number} id Users unique ID.
    *
    * @apiSuccess {String} firstname Firstname of the User.
    * @apiSuccess {String} lastname Lastname of the User.
    *
    * @apiSuccessExample Success-Response:
    * HTTP/1.1 200 OK
    * {
    * "firstname": "John",
    * "lastname": "Doe"
    * }
    *
    * @apiError UserNotFound The id of the User was not found.
    *
    * @apiErrorExample Error-Response:
    * HTTP/1.1 404 Not Found
    * {
    * "error": "UserNotFound"
    * }
    */

    以上是我从网上随便粘贴的一段,虽说本人写代码不是非常洁癖,但这么一大串的注释,本人看着就表示不爽,所以没一点深入了解它的欲望。不介意的就自行研究喽。

     

    优点:同后端代码一起,更新维护距离近在咫尺。

    缺点:注释太大块了,感觉影响看功能,代码显得十分拖沓,影响美观。

     

     

    5.框架内直接编辑markdown文件

    这就是我目前最喜欢的方式,也是本文要讲解实现的方式。

     

    优点:同后端代码一起,维护方便;markdown格式编写,文档撰写省时;所有接口在一个页面或几个划分好的页面里,方便浏览和查找。

    缺点:要做一些前期工作来实现。但现在有了现成的插件和本文的教程支持,缺点就可以忽略不计了。

     

     

    以上几种方式都比较完了,现在我就来实现在Laravel内撰写Api文档,支持网页浏览。

     

    要实现的功能主要就是把指定的md文件转换成html。

    github上有一个人气很旺的插件:erusev/parsedown, 地址:php解析markdown为html的插件:erusev/parsedown

     

    一般项目涉及PC后台,我这里就新增一个路由文件专门来放这些后台的api。

     

    1.安装erusev/parsedown插件。

    编辑composer.json文件,添加代码如下:

     "require": {
    "php": "^7.1.3",
    "fideloper/proxy": "^4.0",
    "laravel/framework": "5.7.*",
    "laravel/tinker": "^1.0",
    "erusev/parsedown":"^1.6" //新增的
    },

     

    项目根目录下执行composer install进行安装。在vendor文件夹下可看到erusev文件夹,则代表安装成功。

     

    2.在app/Providers/RouteServiceProvider.php中引入自定义的后台路由文件。

    public function map()
    {
    $this->mapApiRoutes();
    $this->mapWebRoutes();
    //新增的后台路由
    $this->mapAdminRoutes();
    }

    protected function mapAdminRoutes()
    {
    Route::prefix('admin')
    // ->middleware('api') //避免篇幅过长,中间件的引入这里就忽略了
    ->namespace($this->namespace)
    ->group(base_path('routes/admin.php'));
    }

     

     

    3.添加路由,添加控制器,先调试,要可以成功进入控制器方法。

    routes问价下新增admin.php文件,里面加上我们的api文档路由:

    Route::get('/apidoc', 'Admin\ApiDocController@showDoc');  //注意后面是反斜杠\,否则会报错

    laravel框架入口是public/index.php,为了隐藏这个就自定义个本地解析的名称,编辑apache的httpd-vhosts文件如下:

    <VirtualHost *:80>
    ServerName testlaravel
    DocumentRoot E:/wamp64/www/laravel/public
    <Directory "E:/wamp64/www/laravel/public/">
    Options +Indexes +Includes +FollowSymLinks +MultiViews
    AllowOverride All
    Allow from all
    Header set Access-Control-Allow-Origin *
    </Directory>
    RewriteEngine On
    RewriteCond $1 !^(index\.php|images|robots\.txt)
    RewriteRule ^(.*)$ /index.php/$1 [L]
    </VirtualHost>

    编辑好后,重启apache服务。

     

    现在来加控制器,laravel可以用artisan命令生成,方便快捷。在项目根目录执行如下命令:

    php artisan make:controller Admin/ApiDocController

    接下来编辑controller文件:

    <?php

    namespace App\Http\Controllers\Admin;

    use Illuminate\Http\Request;
    use App\Http\Controllers\Controller;

    class ApiDocController extends Controller
    {
    public function showDoc(Request $request){
    echo "hello coder";
    }
    }

    浏览器输入http://laraveltest/admin/apidoc,直到出现hello coder后才可以进行后面步骤。

     

    4. 使用插件实现markdown转为html

    功能很简单,就直接上代码啦。

    <?php

    namespace App\Http\Controllers\Admin;

    use Illuminate\Http\Request;
    use App\Http\Controllers\Controller;
    use Parsedown;

    class ApiDocController extends Controller
    {
    public function __construct(){
    $this->markdownParser = new Parsedown();
    }

    public function showDoc(Request $request){
    $fileContent = file_get_contents(storage_path('doc/admin_api.md'));
    $htmlContent = $this->convertMarkdownToHtml($fileContent);
    $content = $this->convertMarkdownToHtml($htmlContent);
    return view('apidoc_admin')->with('content',$content);
    }

    public function convertMarkdownToHtml($markdown)
    {
    $convertedHmtl = $this->markdownParser->setBreaksEnabled(true)->text($markdown);
    return $convertedHmtl;
    }
    }

    本文推荐的就是用markdown编辑api的方式,md就是markdown文件的后缀,我现在把这个文件放在storage/doc/admin_api.md处。

    为了测试,我暂时在文件里粘贴了一个markdown格式的api:

    **简要描述:** 

    - 用户登录接口

    **请求URL:**
    - ` http://xx.com/api/user/login `

    **请求方式:**
    - POST

    **参数:**

    |参数名|必选|类型|说明|
    |:---- |:---|:----- |----- |
    |username |是 |string |用户名 |
    |password |是 |string | 密码 |


    **返回示例**
    ```
    {
    "error_code": 0,
    "data": {
    "uid": "1",
    "username": "zhai coder",
    "name": "翟码农",
    "groupid": 2 ,
    "reg_time": "2019-08-01",
    "last_login_time": "0",
    }
    }
    ```
    **返回参数说明**

    |参数名|类型|说明|
    |:----- |:-----|----- |
    |groupid |int |用户组id,1:超级管理员;2:普通用户 |

    **备注**

    - 更多返回错误代码请看首页的错误代码描述

    最后还需要准备好一个view文件。

    我是创建在resources/views文件夹下的,文件名为:apidoc_admin.blade.php。

    方便表达我强烈的推荐意愿,css样式我都给大家调好了,大家直接拿去用吧。

    <!doctype html>
    <html lang="{{ str_replace('_', '-', app()->getLocale()) }}">
    <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Laravel</title>
    <style>
    html, body {
    background-color: #fff;
    color: #636b6f;
    font-family: 'Nunito', sans-serif;
    font-weight: 200;
    height: 100vh;
    margin: 0;
    color:#222; }
    .container{
    width:800px;
    margin:10px auto;
    padding:20px;
    border-left:2px solid silver;
    border-right:2px solid silver; }
    table th,td{
    border:1px solid #ede;
    padding:5px 10px; }
    pre{
    background: #666;
    color: white;
    padding: 20px 10px;
    font-family: yahei;
    overflow: auto; }
    li code{
    font-size: 28px;
    color: #4eb4ee;
    font-weight: bold;
    }
    </style>
    </head>
    <body>
    <div class="container">
    {!! $content !!}
    </div>
    </body>
    </html>

     

    到这里,所有工作算是完成了。

    在浏览器输入api文档访问地址:

    http://testlaravel/admin/apidoc

    一幅如画卷般的文档页面就出来喽。

     

    转载于:https://www.cnblogs.com/drunkhero/p/11397605.html

    展开全文
  • 在实际问题中,矩阵通常是很稀疏的,为了减少计算量,通常采用倒排索引的数据结构[1], 将包含相同word的doc映射到同一个节点上, 这样只需计算相似度不为0的文档之间的相似度, 从而减少计算量,具体过程如图1所示...
  • oracle学习文档 笔记 全面 深刻 详细 通俗易懂 doc word格式 清晰 第一章 Oracle入门 一、 数据库概述 数据库(Database)是按照数据结构来组织、存储和管理数据的仓库,它产生于距今五十年前。简单来说是本身可视...
  • 实现的结果也不一样,有真全屏和假全屏之分,真全屏是将要显示的内容独占显示设备所有的全部资源,程序不加载窗外的框架。另一种是假全屏,实现的原理是调整要显示的内容的尺寸与位置,使之正好充满整个屏幕。假全屏...
  • Latex框架

    2020-05-20 22:44:49
    本文根据刘海洋老师提纲整理的笔记主要介绍Latex大体框架及其对应宏包,具体宏包使用方法还请查看官方文档,文末赋有快速打开文档方法。 LaTeX\LaTeX{}LATE​X 文档的组成 latex编辑器 latex 文档基本结构 文档...
  • word文档自动目录有这样一些好处:秒速生成、自动更新(插入页、删除页、更改标题时)那么如何让目录自动生成呢?首先我们需要在大纲视图下将文章的框架结构整理出来,(大纲是文章的结构脉络,起到提纲挈领的作用,一...
  • 输出mysql数据库设计文档

    千次阅读 2018-08-20 10:07:44
    最近需要把数据库输出word表格文档,由于表较多,一个个表结构复制出来做成文档感觉效率太低,想实现一键导出来,INFORMATION_SCHEMA的数据可以检索出想要的数据,COLUMNS获取所有列数据属性和TABLES获取所有表数据...
  • J-框架-Lucene全文检索

    2021-01-26 19:55:53
    word文档、pdf文档 数据查询: ①结构化数据查询 sql语言 ②非结构化数据查询 1.使用程序读取到内存中,匹配字符串,顺序扫描。(读取速度慢) 2.把非结构化数据变成结构化数据,进行查询。 拆分,提供索引,进行...
  • 作为一个软件工程师,编写技术文档是常有的事情,使用visio绘制各种图形(如,流程图,结构图,框架图,状态图等等)也是再正常不过的事情。 如果我们在word中撰写...方便的做法就是直接将visio对象插入word文档中去...
  • Atitit office系列 excel的读取api 框架 poi的使用   目录 1. 主要内容 1 2. 案例功能 2 3. 意义:: 2 ...4. 文档体系结构与背景知识 2 ...4.1. 文档的三大分类体系 纯...4.3. 文档常见子分类按照用途( 文字word...
  • 富文本 ...一个富文本的文档结构主要分为几种元素:框架(QTextFrame)、文本块(QTextBlock)、表格(QTextTable)、和列表(QTextList)。 每种元素的格式有相应的format类表示:框架格式(QTextF
  • 文档中主要是笔者学习数据结构过程中结合教材总结的基础知识。分树、图、比较排序、非比较排序四部分。文档仅供参考,可提供大致知识框架,上传格式为word,便于读者进一步编辑学习。望采纳。
  • 需求:oracle数据库中的表结构是web工程框架hibernate 自动生成,现需要将数据库中已有的所有业务表结构用PowerDesigner 生成ER图,并将各表结构直接导出成word文档。 前提:我本地已安装好oracle10g 服务端...
  • 自家:hsweb-commons :通用工具类hsweb-easy-orm :为动态表单设计的orm框架hsweb-expands-compress :文件压缩,解压操作hsweb-expands-office :office文档操作( excel读写,模板导出,word模板导出)hsweb-...
  • 目前Toxy支持的结构有string – 文本结构ToxyDom – Dom结构ToxySpreadsheet – 类似Excel的表单结构ToxyDocument – 类似Word的描述性文本结构ToxyEmail – 邮件结构,包括收件人、发件人、邮件内容、附件等...
  • Solr Indexing(solr 官方文档

    千次阅读 2016-07-27 10:32:06
    solr的索引可以接受不同的数据源,...1、Solr Cell 框架提取二进制文件或结构化文件,如office word,PDF等 2、向solr服务器发送HTTP请求来加载xml文件 3、利用solr的java API solr的索引包含一个或多个document,
  • 学习元搜索自然就需要文档聚类和搜索结果聚类的算法,于是在SF 上找了找,发现了一些还活跃着的项目,都是Java 语言开发的。...一个结合了结构化查询和文档聚类技术的可扩展的框架及用户接口 Java M
  • 根据模板结构生成代码文件 技术点三:新一代代码生成器支持Vue+ElementUI风格,Bootstrap表单+EasyUI原生态列表风格,ElementUI表单+EasyUI原生态列表风格 技术点四:Dategrid标签多列表风格快速切换,给用户...
  • 小白也能通过学习 JS、CSS、HTML 这些基础,达到快速入门的作用,为以后更快速的学习框架...将会从最基础的 JS 的 Hello Word 说起,逐步扩展到 JS 的 DOM 模型,文档结构,以及 JS 的同源策略。将会详细解释浏览器...

空空如也

空空如也

1 2 3 4 5 ... 7
收藏数 126
精华内容 50
关键字:

word文档框架结构